Get Started 

API Endpoint
https://developers.prophawk.com/propertyDetails

The Prophawk API provides programmatic access to real estate data, allowing you to retrieve property listings, obtain county information, filter results, and more.

To begin using the API, you'll need an Client ID and Secret Key. If you don't have one yet, you can easily obtain it by signing up for an account. Once you have your Client ID and Secret Key, you can start accessing the wealth of real estate data available through our platform.

To get started, please sign up to create your account and obtain your Client ID and Secret Key.

Generate Token 


# Here is a curl example
curl --location 'https://developers.prophawk.com/propertyDetails/generate-token' \
--form 'user_id="99XXXXXXX"' \
--form 'secret_key="9647372e7e5xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"'


# Here is a php example
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://developers.prophawk.com/propertyDetails/generate-token',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('user_id' => '99XXXXXXX','secret_key' => '9647372e7e5xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'),
));
$response = curl_exec($curl);
curl_close($curl);

To generate a token, make a POST request to the following URL:
https://developers.prophawk.com/propertyDetails/generate-token

The generated token is only valid for 24 hrs. If the token is expired please generate a new token. 


Success Response:
{
  "status": true,
  "code": 200,
  "token": "f63bfXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}


Error Response:
{
    "status": false,
    "code": 400,
    "error": "Invalid UserID or SecretKey"
}

Parameters

Attributes Type Description
user_id String Client ID
secret_key String Client Secret Key

Properties Listing 


# Here is a curl example
curl --location 'https://developers.prophawk.com/propertyDetails/fetchProperties' \
--header 'UserID: 99XXXXXXX' \
--header 'Token: f63bfXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--form 'StateCode="AK"' \
--form 'page="1"' \
--form 'fields="1,2,3,4,5,6,7,8"' \
--form 'PropertyID="3518065"'


# Here is a PHP example

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://developers.prophawk.com/propertyDetails/fetchProperties',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('StateCode' => 'AK'),
  CURLOPT_HTTPHEADER => array(
    'UserID: 99XXXXXXX',
    'Token: f63bfXXXXXXXXXXXXXXXXXXXXXXXXXXX'
  ),
));

$response = curl_exec($curl);

curl_close($curl);

To Fetch property listing , make a POST request to the following URL:
https://developers.prophawk.com/propertyDetails/fetchProperties 


Success Response:
{
    "Result": {
        "ASSESSOR": {
            "3518065": {
                "FIPS": "02070",
                "PROPERTYID": "3518065",
                "FORMATTEDAPN": "000193-000",
                "APNSEQNBR": null,
                "OLDAPN": null,
                ...
            }
        },
        "ASR": {
            "3518065": [
                {
                    "FIPS": "02070",
                    "PROPERTYID": "3518065",
                    "APN": "000193-000",
                    "APNSEQNBR": null,
                    ...
                },
                {
                    "FIPS": "02070",
                    "PROPERTYID": "3518065",
                    "APN": "000193-000",
                    "APNSEQNBR": null,
                    "OLDAPN": null,
                    ...
                },
                {
                    "FIPS": "02070",
                    "PROPERTYID": "3518065",
                    "APN": "000193-000",
                    "APNSEQNBR": null,
                    "OLDAPN": null,
                    "TAXACCOUNTNUMBER": null,
                    "SITUSFULLSTREETADDRESS": "14 F ST",
                    ...
                }
            ]
        },
        "AVM": {
            "Status": false,
            "Code": 400,
            "Msg": "No Record Found.",
            "total_c": 0
        },
        "FORECLOSURE": {
            "Status": false,
            "Code": 400,
            "Msg": "No Record Found.",
            "total_c": 0
        },
        "INVLIEN": {
            "Status": false,
            "Code": 400,
            "Msg": "No Record Found.",
            "total_c": 0
        },
        "PROPENSITY_SCORES": {
            "Status": false,
            "Code": 400,
            "Msg": "No Record Found.",
            "total_c": 0
        },
        "DEED_MORTGAGE": {
            "3518065": [
                {
                    "FIPSCODE": "02070",
                    "PROPERTYUNIQUEID": "3518065",
                    "APN": "000193-000",
                    "APNSEQUENCENBR": null,
                    ...
                }
            ]
        },
        "LISTINGS": {
            "Status": false,
            "Code": 400,
            "Msg": "No Record Found.",
            "total_c": 0
        },
        "Msg": "1 ",
        "Status": true,
        "Code": 200
    }
}


Invalid Token Response:
{
    "status": false,
    "code": 400,
    "error": "UserID and Token are required"
}


Error Response:
{
    "status": false,
    "code": 400,
    "error": "StateCode parameter is required."
}


Error Response:
{
    "status": false,
    "code": 400,
    "error": "At least one parameter is required.",
    "required_parameters": [
        "County",
        "City",
        "ZIP",
        "Street",
        "FIPS",
        "PropertyID"
    ]
}


Error Response:
{
    "Status": true,
    "Code": 200,
    "Msg": "No Property found"
}

Parameters

Attributes Type Description
StateCode (required) String State Code(e.g. TX)
County String County Name
City String City Name
Street String Street Address
ZIP String ZIP Code
FIPS String FIPS Code
page String Page number(e.g. 1)
PropertyID String Property ID
fields String 1,2,3,4,5,6,7,8
1 ASSESSOR
2 ASR
3 AVM
4 FORECLOSURE
5 INVLIEN
6 PROPENSITY_SCORES
7 DEED_MORTGAGE
8 LISTINGS

Atlest one of them is required 'County', 'City', 'ZIP', 'Street', 'FIPS', 'PropertyID'

Get State Code 


# Here is a curl example
curl --location --request POST 'https://developers.prophawk.com/propertyDetails/getStateCodes' \
--header 'UserID: 99XXXXXXX' \
--header 'Token: f63bfXXXXXXXXXXXXXXXXXXXXXXXXXXX'


# Here is a PHP example

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://developers.prophawk.com/propertyDetails/getStateCodes',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => array(
    'UserID: 99XXXXXXX'
  ),
));

$response = curl_exec($curl);

curl_close($curl);

To get state code, make a POST request to the following URL:
https://developers.prophawk.com/propertyDetails/getStateCodes 


Success Response:
[
    {
        "StateCode": "AL",
        "StateName": "Alabama"
    },
    {
        "StateCode": "AK",
        "StateName": "Alaska"
    },
    {
        "StateCode": "AZ",
        "StateName": "Arizona"
    },
    {
        "StateCode": "AR",
        "StateName": "Arkansas"
    },
    {
        "StateCode": "CA",
        "StateName": "California"
    },
    {
        "StateCode": "CO",
        "StateName": "Colorado"
    },
    {
        "StateCode": "CT",
        "StateName": "Connecticut"
    },
    {
        "StateCode": "DE",
        "StateName": "Delaware"
    },
    {
        "StateCode": "DC",
        "StateName": "District of Columbia"
    },
    {
        "StateCode": "FL",
        "StateName": "Florida"
    },
    {
        "StateCode": "GA",
        "StateName": "Georgia"
    },
    {
        "StateCode": "HI",
        "StateName": "Hawaii"
    },
    {
        "StateCode": "ID",
        "StateName": "Idaho"
    },
    {
        "StateCode": "IL",
        "StateName": "Illinois"
    },
    {
        "StateCode": "IN",
        "StateName": "Indiana"
    },
    {
        "StateCode": "IA",
        "StateName": "Iowa"
    },
    {
        "StateCode": "KS",
        "StateName": "Kansas"
    },
    {
        "StateCode": "KY",
        "StateName": "Kentucky"
    },
    {
        "StateCode": "LA",
        "StateName": "Louisiana"
    },
    {
        "StateCode": "ME",
        "StateName": "Maine"
    },
    {
        "StateCode": "MD",
        "StateName": "Maryland"
    },
    ...
]


Invalid Token Response:
{
    "status": false,
    "code": 400,
    "error": "UserID and Token are required"
}


Error Response:
{
    "status": false,
    "code": 400,
    "error": "Failed to retrieve state codes"
}

Get properties on mail 


# Here is a curl example
curl --location 'https://developers.prophawk.com/propertyDetails/mailProperties' \
--header 'UserID: 99XXXXXXX' \
--header 'Token: f63bfXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--form 'StateCode="AK"' \
--form 'page="1"' \
--form 'fields="1,2,3,4,5,6,7,8"' \
--form 'PropertyID="3518065"'


# Here is a PHP example

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://developers.prophawk.com/propertyDetails/mailProperties',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('StateCode' => 'AK','page' => '1','fields' => '1,2,3,4,5,6,7,8','PropertyID' => '3518065'),
  CURLOPT_HTTPHEADER => array(
    'UserID: 99XXXXXXX',
    'Token: f63bfXXXXXXXXXXXXXXXXXXXXXXXXXXX'
  ),
));

$response = curl_exec($curl);

curl_close($curl);

To get properties on mail, make a POST request to the following URL:
https://developers.prophawk.com/propertyDetails/mailProperties 


Success Response:
{
    "message": "FOUND 1 Properties. Your request is being processed. You will receive an email on your registered mail ID as soon as your data is ready. Please note your request ID is: req_65f82b15XXXXXX.XXXXXXXX"
}


Invalid Token Response:
{
    "status": false,
    "code": 400,
    "error": "UserID and Token are required"
}


Error Response:
{
    "status": false,
    "code": 400,
    "error": "StateCode parameter is required."
}


Error Response:
{
    "status": false,
    "code": 400,
    "error": "At least one parameter is required.",
    "required_parameters": [
        "County",
        "City",
        "ZIP",
        "Street",
        "FIPS",
        "PropertyID"
    ]
}

Parameters

Attributes Type Description
StateCode (required) String State Code(e.g. TX)
County String County Name
City String City Name
Street String Street Address
ZIP String ZIP Code
FIPS String FIPS Code
page String Page number
PropertyID String Property ID
fields String 1,2,3,4,5,6,7,8
1 ASSESSOR
2 ASR
3 AVM
4 FORECLOSURE
5 INVLIEN
6 PROPENSITY_SCORES
7 DEED_MORTGAGE
8 LISTINGS

Atlest one of them is required 'County', 'City', 'ZIP', 'Street', 'FIPS', 'PropertyID'

Get Request Status 


# Here is a curl example
curl --location 'https://developers.prophawk.com/propertyDetails/getRequestStatus' \
--header 'UserID: 99XXXXXXX' \
--header 'Token: f63bfXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--form 'requestID="req_65f81366ba4209.29370566"'


# Here is a PHP example
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://developers.prophawk.com/propertyDetails/getRequestStatus',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('requestID' => 'req_65f81366ba4209.29370566'),
  CURLOPT_HTTPHEADER => array(
    'UserID: 99XXXXXXX',
    'Token: f63bfXXXXXXXXXXXXXXXXXXXXXXXXXXX'
  ),
));

$response = curl_exec($curl);

curl_close($curl);

To get request staus of mailProperties API, make a POST request to the following URL:
https://developers.prophawk.com/propertyDetails/getRequestStatus 


Success Response:
{
    "status": true,
    "message": "Your request has been completed. Please check your email",
    "code": 200
}


Processing Response:
{
    "status": true,
    "completed": "28%",
    "message": "Your request is under process",
    "code": 200
}


Invalid Token Response:
{
    "status": false,
    "code": 400,
    "error": "UserID and Token are required"
}


Error Response:
{
    "status": false,
    "code": 400,
    "error": "requestID parameter is required."
}


Failed Response:
{
    "message": "Your request has failed. Please submit a new request.",
    "parameters": "{"StateCode":"AL","page":"1","fields":"1,2,3,4,5,6,7,8","PropertyID":"3518065"}",
    "status": true,
    "code": 200
}

Parameter

Attributes Type Description
requestID (required) String Request ID generated from the Mail Properties API