corelogic

Create CoreLogic connection object

Since R2026a

expand all in page

    Description

    The corelogic function creates an object that represents a connection to the CoreLogic® data server, which offers access to climate and property data through a REST API. After you create a corelogic object, you can retrieve data for use in your climate, insurance, and property data workflows. CoreLogic allows you to retrieve data from the following categories:

    • Property records

    • Natural hazard risk (physical risk)

    • Property mapping visualization data

    • Property data for insurance solutions

    • Property parcel information

    • Weather event monitoring

    • Tax servicing

    • Historical post weather events

    • Property fraud risk

    • Legal information

    • Property ownership reports

    Creation

    Syntax

    c = corelogic(ConsumerKey,ConsumerSecret)
    c = corelogic(ConsumerKey,ConsumerSecret,timeout,url,mediatype,debugmodevalue)

    Description

    c = corelogic(ConsumerKey,ConsumerSecret) creates a connection to the CoreLogic data server that allows you to access climate, insurance, and property data based on the credentials that you provide in Consumerkey and ConsumerSecret. For more information on user credentials and data categories, see the API documentation on the CoreLogic website.

    example

    c = corelogic(ConsumerKey,ConsumerSecret,timeout,url,mediatype,debugmodevalue) additionally sets the timeout value, the CoreLogic base endpoint URL, the REST API call media type, and the MATLAB® HTTP library debug value for the connection to the CoreLogic data server.

    Input Arguments

    expand all

    Consumer key for your CoreLogic connection, specified as a string scalar or character vector. CoreLogic provides this key for accessing the server.

    Consumer secret for your CoreLogic connection, specified as a string scalar or character vector. CoreLogic provides this secret for accessing the server.

    Timeout value for CoreLogic REST API call responses, specified as a positive numeric scalar representing the number of seconds before the data server times out. This argument sets the TimeOut property.

    CoreLogic base endpoint URL, specified as a string scalar or character vector. In API documentation, the base endpoint URL is the initial part of the API URL, which provides a shared prefix for all API requests. This argument sets the URL property.

    REST API call media type, specified as a string scalar or character vector. This argument defines the allowed resource structure of the payload exchanged between the client and data server. For more information about media types, see the API documentation on the CoreLogic website. This argument sets the MediaType property.

    MATLAB HTTP library debug mode, specified as 0, 1, or 2. The value of this argument controls the amount of diagnostic information that MATLAB returns about your server connection.

    • 0 returns no diagnostic information.

    • 1 returns partial diagnostic information.

    • 2 returns complete diagnostic information.

    This argument sets the DebugModeValue property.

    Properties

    expand all

    Public

    Timeout value in seconds for CoreLogic REST API call responses. The timeout argument sets this property.

    Private

    CoreLogic authentication token. The ConsumerKey and ConsumerSecret arguments set this property.

    Hidden

    MATLAB HTTP library debug value. The debugmodevalue argument sets this property.

    REST API call media type. The mediatype argument sets this property.

    CoreLogic base endpoint URL. The url argument sets this property.

    Object Functions

    getDataRetrieve data from CoreLogic

    Examples

    collapse all

    This example assumes that you have obtained your user credentials from CoreLogic and you stored them in the MATLAB vault by using the setSecret function. Use the corelogic function by specifying the ConsumerKey and ConsumerSecret arguments with the getSecret function. Then, display the connection properties.

    ConsumerKey = getSecret("ConsumerKeyCoreLogic");
ConsumerSecret = getSecret("ConsumerSecretCoreLogic");
c = corelogic(ConsumerKey,ConsumerSecret)
    c =

     corelogic with properties: 

        TimeOut: 200.00

    Version History

    Introduced in R2026a

    See Also

    | |