Skip to main content
curl --request GET \
  --url "https://api.trestleiq.com/3.1/location?address.street_line_1=100%20Main%20St&address.city=Seattle&address.state_code=WA&address.postal_code=98101" \
  --header "x-api-key: YOUR_API_KEY"
{
  "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
  "is_valid": true,
  "street_line_1": "100 Syrws St",
  "street_line_2": "Ste 1",
  "city": "Lynden",
  "postal_code": "98264",
  "zip4": "98264-9999",
  "state_code": "WA",
  "country_code": "US",
  "lat_long": {
    "latitude": 0,
    "longitude": 0,
    "accuracy": "Neighborhood"
  },
  "is_active": true,
  "is_commercial": true,
  "delivery_point": "SingleUnit",
  "current_residents": [
    {
      "id": "Person.fffdcf06-0929-4b5a-9921-ee49b101ca84",
      "name": "Waidong L Syrws",
      "firstname": "Waidong",
      "middlename": "L",
      "lastname": "Syrws",
      "alternate_names": [
        "Sryws W L"
      ],
      "age_range": "25-29",
      "gender": null,
      "type": "Person",
      "industry": [
        "Service Provider"
      ],
      "link_to_address_start_date": "2023-01-02",
      "phones": [
        {
          "id": "Phone.3dbb6fef-a2df-4b08-cfe3-bc7128b6f5b4",
          "phone_number": "2069735100",
          "line_type": "NonFixedVOIP"
        }
      ],
      "emails": "waidong.syrws@email.com",
      "historical_addresses": [
        {
          "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
          "location_type": "Address",
          "street_line_1": "10 Main St",
          "street_line_2": "Ste 1",
          "city": "Lynden",
          "postal_code": "98264",
          "zip4": "98264-9999",
          "state_code": "WA",
          "country_code": "US",
          "lat_long": {
            "latitude": 0,
            "longitude": 0,
            "accuracy": "Neighborhood"
          },
          "is_active": true,
          "delivery_point": "SingleUnit",
          "link_to_person_start_date": "2011-10-05",
          "link_to_person_end_date": null
        }
      ],
      "associated_people": [
        {
          "id": "Person.fffdcf06-0929-4b5a-9921-ee49b101ca84",
          "name": "Waidong L Syrws",
          "firstname": "Waidong",
          "middlename": "L",
          "lastname": "Syrws",
          "relation": "Household"
        }
      ]
    }
  ],
  "error": {
    "name": "InternalError",
    "message": "Could not retrieve entire response"
  },
  "warnings": [
    "Missing Input"
  ]
}
GET
/
3.1
/
location
curl --request GET \
  --url "https://api.trestleiq.com/3.1/location?address.street_line_1=100%20Main%20St&address.city=Seattle&address.state_code=WA&address.postal_code=98101" \
  --header "x-api-key: YOUR_API_KEY"
{
  "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
  "is_valid": true,
  "street_line_1": "100 Syrws St",
  "street_line_2": "Ste 1",
  "city": "Lynden",
  "postal_code": "98264",
  "zip4": "98264-9999",
  "state_code": "WA",
  "country_code": "US",
  "lat_long": {
    "latitude": 0,
    "longitude": 0,
    "accuracy": "Neighborhood"
  },
  "is_active": true,
  "is_commercial": true,
  "delivery_point": "SingleUnit",
  "current_residents": [
    {
      "id": "Person.fffdcf06-0929-4b5a-9921-ee49b101ca84",
      "name": "Waidong L Syrws",
      "firstname": "Waidong",
      "middlename": "L",
      "lastname": "Syrws",
      "alternate_names": [
        "Sryws W L"
      ],
      "age_range": "25-29",
      "gender": null,
      "type": "Person",
      "industry": [
        "Service Provider"
      ],
      "link_to_address_start_date": "2023-01-02",
      "phones": [
        {
          "id": "Phone.3dbb6fef-a2df-4b08-cfe3-bc7128b6f5b4",
          "phone_number": "2069735100",
          "line_type": "NonFixedVOIP"
        }
      ],
      "emails": "waidong.syrws@email.com",
      "historical_addresses": [
        {
          "id": "Location.d1a40ed5-a70a-46f8-80a9-bb4ac27e3a01",
          "location_type": "Address",
          "street_line_1": "10 Main St",
          "street_line_2": "Ste 1",
          "city": "Lynden",
          "postal_code": "98264",
          "zip4": "98264-9999",
          "state_code": "WA",
          "country_code": "US",
          "lat_long": {
            "latitude": 0,
            "longitude": 0,
            "accuracy": "Neighborhood"
          },
          "is_active": true,
          "delivery_point": "SingleUnit",
          "link_to_person_start_date": "2011-10-05",
          "link_to_person_end_date": null
        }
      ],
      "associated_people": [
        {
          "id": "Person.fffdcf06-0929-4b5a-9921-ee49b101ca84",
          "name": "Waidong L Syrws",
          "firstname": "Waidong",
          "middlename": "L",
          "lastname": "Syrws",
          "relation": "Household"
        }
      ]
    }
  ],
  "error": {
    "name": "InternalError",
    "message": "Could not retrieve entire response"
  },
  "warnings": [
    "Missing Input"
  ]
}

Reverse Address 3.1

GET https://api.trestleiq.com/3.1/location?api_key=[insert_key]&city=[insert_city]&postal_code=[insert_postal_code]&state_code=[insert_state_code]&street_line_1=[insert_street_line_1]

Query Parameters

street_line_1
string
The first line of the street part in the structured address. Cannot be longer than 1000 characters. Example: street_line_1=100 Syrws St
street_line_2
string
The second line of the street part in the structured address. Cannot be longer than 1000 characters. Example: street_line_2=Ste 1
city
string
The name of the city in the structured address. Cannot be longer than 500 characters. Example: city=Seattle
state_code
string
The state code of the structured address. Cannot be longer than 100 characters. Example: state_code=WA
postal_code
string
The postal code of the structured address. Cannot be longer than 100 characters. Example: postal_code=98101
country_code
string <ISO-3166-2>
The ISO-3166 alpha-2 country code of the address. Cannot be longer than 100 characters. Example: country_code=US

Headers

x-api-key
string
required
Your API key for authentication. Example: {{ apiKey }}

Response

id
string or null <Location.<uuid>>
The persistent ID of the address.
is_valid
boolean or null
True if the address is valid.
street_line_1
string or null
The first line of the street part in the structured address.
street_line_2
string or null
The second line of the street part in the structured address.
city
string or null
The name of the city in the structured address.
postal_code
string or null
The postal code of the structured address.
state_code
string or null
The state code of the structured address.
zip4
string or null ^\d+-\d{4}$
The ZIP+4 code of the structured address (USA).
country_code
string or null <ISO-3166-2>
The ISO-3166 alpha-2 country code of the address.
lat_long
object or null
The coordinates of the geographical location of the address.
is_active
boolean or null
True if the address is currently receiving mail.
is_commercial
boolean or null
True if the address is a business address. When shipping physical goods, commercial addresses are typically a positive signal and indicate that the order is not fraudulent.
delivery_point
string or null (DeliveryPoint)
The type of the delivery point of the address. Enum: SingleUnit MultiUnit POBox PartialAddress
current_residents
object[]
The list of current person and business residents at the address.
error
object(PartialError)
Error details in case of an error.
warnings
string[]
Warnings returned as part of the response, if applicable. The possible values include - Invalid Input, International number. Not authorized, or Missing Input.

Error Responses

400 Bad Request:

  • Indicates that the server cannot process the request due to client-side errors.

403

  • Invalid API Key: Indicates that the API key is either incorrect or has been deactivated.
  • API Key Missing: Indicates that your request did not include an API key.
  • API Key Expired: Indicates that the API key has expired.

429 Too Many Requests:

  • API Key has exceeded its rate limit.

500 Internal Server Error:

  • An unexpected error occurred on the server.