sahakavatar / corelogic-api
1.0.0
2025-02-05 11:49 UTC
Requires
- php: ^7.4 || ^8.2
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
This package is not auto-updated.
Last update: 2025-05-01 11:24:53 UTC
README
SDP Property API.
This PHP package is automatically generated by the Swagger Codegen project:
- API version: v2.0
- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "git",
"url": "https://github.com/git_user_id/git_repo_id.git"
}
],
"require": {
"git_user_id/git_repo_id": "*@dev"
}
}
Then run composer install
Manual Installation
Download the files and include autoload.php
:
require_once('/path/to/SwaggerClient-php/vendor/autoload.php');
Tests
To run the unit tests:
composer install
./vendor/bin/phpunit
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); $apiInstance = new Swagger\Client\Api\BuildingControllerApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client() ); $clip = "clip_example"; // string | Unique Clip Id try { $result = $apiInstance->buildings($clip); print_r($result); } catch (Exception $e) { echo 'Exception when calling BuildingControllerApi->buildings: ', $e->getMessage(), PHP_EOL; } ?>
Documentation for API Endpoints
All URIs are relative to https://property.corelogicapi.com
Class | Method | HTTP request | Description |
---|---|---|---|
BuildingControllerApi | buildings | GET /v2/properties/{clip}/buildings | Buildings |
BuildingPermitsControllerApi | buildingPermits | GET /v2/properties/{clip}/building-permits | BuildingPermits |
ClimateRiskAnalyticsControllerApi | cRAAR5Comprehensive | GET /v2/properties/{clip}/climate-risk-analytics/ar5/comprehensive | Climate Risk Analytics - Comprehensive |
ClimateRiskAnalyticsControllerApi | cRAAR6Comprehensive | GET /v2/properties/{clip}/climate-risk-analytics/ar6/comprehensive | CRA-AR6-Comprehensive |
DocumentImageControllerApi | recordedDocumentImages | GET /v2/properties/document-images/{product} | |
EnrichedVoluntaryLiensControllerApi | openVoluntaryLiensEnriched | GET /v2/properties/liens/enriched/{clip} | Open Voluntary Liens Enriched Risk Management |
InvoluntaryLiensControllerApi | involuntaryLiens | GET /v2/properties/liens/involuntary-liens/{clipId} | |
MortgageControllerApi | currentMortgage | GET /v2/properties/{clip}/mortgage/current | CurrentMortgage |
MortgageControllerApi | mortgageHistory | GET /v2/properties/{clip}/mortgage | MortgageHistory |
OwnershipControllerApi | ownership | GET /v2/properties/{clip}/ownership | Ownership |
OwnershipTransfersControllerApi | ownershipTransfers | GET /v2/properties/{clip}/ownership-transfers/{saleType}/{latest} | Ownership Transfers |
PropensityControllerApi | propensityToHELOC | GET /v2/properties/propensity-scores/{clip}/heloc-score | Heloc Propensity Score by clip |
PropensityControllerApi | propensityToListForRent | GET /v2/properties/propensity-scores/{clip}/rent-score | Rent Propensity Score by clip |
PropensityControllerApi | propensityToListForSale | GET /v2/properties/propensity-scores/{clip}/sale-score | Sales Propensity Score by clip |
PropensityControllerApi | propensityToPurchaseMortgage | GET /v2/properties/propensity-scores/{clip}/purchase-score | Purchase Propensity Score by clip |
PropensityControllerApi | propensityToRefinance | GET /v2/properties/propensity-scores/{clip}/refinance-score | Refinance Propensity Score by clip |
PropertyComparablesControllerApi | comparables | GET /v2/properties/{clipId}/comparables | |
PropertyControllerApi | geocode | GET /v2/properties/search/geocode | Property search by address, city, state, zip code and apn with Geocode results |
PropertyControllerApi | propertySearch | GET /v2/properties/search | Property search by address, city, state, zip code and apn |
PropertyControllerApi | propertySearchByOwnerS | GET /v2/properties/search/owner | Property search by Address or APN or Owner |
PropertyDetailControllerApi | propertyDetail | GET /v2/properties/{clip}/property-detail | Property Detail query for multiple blocks and products. |
RentAmountModelControllerApi | rentAmountModel | GET /v2/avms/ram | Rent Amount Model |
SiteLocationControllerApi | siteLocation | GET /v2/properties/{clip}/site-location | Site Location |
SolarAndPaceControllerApi | solarAndPACELiens | GET /v2/properties/liens/SolarPACE-lien/{clip} | |
TaxAssessmentControllerApi | taxAssessments | GET /v2/properties/{clip}/tax-assessments/latest | Tax Assessments |
TransactionHistoryControllerApi | transactionHistory | GET /v2/properties/{clip}/transaction-history | Transaction History Unrestricted |
TypeAheadControllerApi | addressTypeAhead | GET /v2/properties/typeahead | AddressTypeAhead |
VoluntaryLiensControllerApi | openLienEquityAndLTVSummary | GET /v2/properties/{clip}/liens | Open Lien Equity and LTV Summary |
Documentation For Models
- AdditionalValues
- AddressDTO
- AirConditioning
- AllBuildingsSummary
- AnnualExceedanceProbability
- AnnualExceedanceProbabilityTvar
- AssessedValue
- Attic
- Basement
- BathroomFixtures
- BorrowerDetail
- BorrowerNameDetail
- Building
- BuildingData
- BuildingPermitStatus
- BuildingPermits
- BuildingPermitsItem
- BuildingResponseData
- BuyerDetails
- BuyerName
- BuyerParsedName
- Cbsa
- Ceiling
- CensusTract
- ClimateRiskAR6AnnualExceedanceProbability
- ClimateRiskAR6AnnualExceedanceProbabilityTvar
- ClimateRiskAR6ClientData
- ClimateRiskAR6ClientResponse
- ClimateRiskAR6OccurrenceExceedanceProbability
- ClimateRiskAR6OccurrenceExceedanceProbabilityTvar
- ClimateRiskAR6Perils
- ClimateRiskAR6TimeHorizons
- ClimateRiskAnalyticsAR6
- ClimateRiskAnalyticsRcpScenarios
- CollectionPoint
- CommunityCollege
- ConstructionDetails
- Contractor
- CoordinatesBlock
- CoordinatesParcel
- CountyLienCoverageSummary
- CraComprehensiveAllDataResponse
- CraComprehensiveAllPeril
- CraComprehensiveAllResponse
- CraComprehensiveAllRiskScenario
- CraComprehensiveAllTimeframe
- CurrentOwnerMailingInfo
- CurrentOwners
- Data
- DeedPropertyOwner
- DocumentImageResponseData
- DormerWindows
- Elementary
- EnrichedLienArm
- EnrichedLienCurrentLender
- EnrichedLienEstimatedPIQ
- EnrichedLienLender
- EnrichedLienLoanIndicator
- EnrichedLienLoanModification
- EnrichedLienMortgageRiskTransaction
- EnrichedLienRecordedDocument
- EnrichedLienRiskEquity
- EnrichedLienRiskTransaction
- EnrichedLiensCountyMortgageCoverageSummary
- EnrichedLiensRiskData
- ErrorResponse
- ErrorResponseErrorResponse
- EstimatedValueRange
- Fire
- FirePlaces
- Flooring
- Geocode
- GeocodeDetail
- GeocodeProduct
- Heating
- High
- HoaLienPlaintiff
- HoaLienTransaction
- HoaLienTransactionDetails
- HoaLienTransactionId
- InteriorArea
- InteriorRooms
- InvoluntaryLiensRootResponse
- Item
- JurisdictionCounty
- LandUseAndZoningCodes
- LenderDetail
- LienEquity
- LienOwners
- LiensData
- Lighting
- Location
- LocationLegal
- LocationSurvey
- Lot
- MailingAddress
- MailingPropertyAddress
- MechanicsLienPlaintiff
- MechanicsLienTransaction
- MechanicsLienTransactionDetails
- MechanicsLienTransactionId
- Message
- Metadata
- Middle
- ModelOutput
- MortgageArmDetail
- MortgageCoverageSummary
- MortgageDetail
- MortgageRiderDetail
- MortgageTitleDetail
- MortgageTransactionDetail
- MortgageTransactionIdDetail
- MortgageTransactionIndicatorDetail
- MortgageTransactionProduct
- Municipality
- NMLSDetail
- Neighborhood
- OccurrenceExceedanceProbability
- OccurrenceExceedanceProbabilityTvar
- OriginalSolarTransaction
- OriginalTaxLienTransaction
- OwnerMailingAddress
- OwnerName
- Owners
- OwnershipData
- OwnershipResponseData
- OwnershipTransfers
- OwnershipTransfersItem
- OwnershipTransfersProduct
- PaceBuyerMailingAddress
- PaceBuyerName
- PaceLienDetails
- PaceLienTransaction
- PaceRecordId
- PaceTransaction
- Parking
- PassengerElevators
- Patio
- Permit
- PermitClassificationType
- Plumbing
- Pool
- Porch
- PrincipalDetail
- ProgramProductCodes
- Project
- PropensityData
- PropertyAddressMatchInformation
- PropertyApn
- PropertyComparablesDataResponse
- PropertyComparablesRootResponse
- PropertyDetailResponse
- PropertyDetails
- PropertyMatchInfo
- PropertySearchAddress
- PropertySearchByOwnerApn
- PropertySearchByOwnerNameDetail
- PropertySearchByOwnerNameProduct
- PropertySearchDetail
- PropertySearchProduct
- PropertyStreetAddressParsed
- PropertyTaxLienTransaction
- RecordedPropertyAddress
- RentAmountModelData
- RentAmountModelResponseData
- ResponseMessage
- ResponseMessages
- Roof
- School
- SchoolDistricts
- SellerDetails
- SellerName
- ServiceDistricts
- Sewer
- SingleApiResponseEnrichedLiensRiskData
- SingleApiResponseLiensData
- SingleApiResponsePropensityData
- SingleApiResponseSiteLocationData
- SiteLocationData
- SiteLocationResponseData
- SolarContractDetails
- SolarContractTransaction
- SolarContractTransactionDetails
- SolarContractTransactionId
- SolarPACELiensRootResponse
- SolarPaceLiensCountyLienCoverageSummary
- SolarPaceLiensData
- SolarPaceLiensOwnerName
- SolarRequesterAddress
- SolarRequesterName
- StreetAddressParsed
- StructureClassification
- StructureExterior
- StructureFeatures
- StructureFootprint
- StructureId
- StructureInterior
- StructureUnitsSummary
- StructureVerticalProfile
- SubjectTransaction
- SubjectTransactionDetail
- Tax
- TaxAmount
- TaxAssessment
- TaxDistrict
- TaxExemptions
- TaxLienDetails
- TaxLienTransaction
- TaxPayerMailingAddress
- TaxPayerName
- TaxRateArea
- TaxrollUpdate
- TitleCompany
- Town
- TransactionDetails
- TransactionHistoryBorrowerDetail
- TransactionHistoryBorrowerNameDetail
- TransactionHistoryBuyerDetails
- TransactionHistoryBuyerName
- TransactionHistoryData
- TransactionHistoryDetails
- TransactionHistoryItems
- TransactionHistoryLenderDetail
- TransactionHistoryMortgageArmDetail
- TransactionHistoryMortgageDetail
- TransactionHistoryMortgageRiderDetail
- TransactionHistoryMortgageTransactionDetail
- TransactionHistoryPrincipalDetail
- Trash
- TypeAheadResponse
- UtilitiesType
- Utility
- Wall
- Walls
- Water
Documentation For Authorization
property_auth
- Type: OAuth
- Flow: accessCode
- Authorization URL:
- Scopes: