Get rate center by location

GET 
/geo/location

Lookup rate centers using zipcode or city/state, only exact matches are supported.

Requires an authorization header or IP Auth setup through the portal.

Request

Query Parameters

type stringrequired

Must be either 'zipcode' or 'city_state'

zipcode string

Zipcode to query for. Required if type = zipcode

city string

City to query for. Required if type = city_state

Responses

200: Success. The response will be an array of RatecenterResults or the NoResults object.

application/json

• Schema
• Example (from schema)

Schema

• Array [

rc_name string

Ratecenter name

rc_abbre string

Ratecenter abbreviation

state string

State

npa_nxx

object[]

Array [

npa string

nxx string

ocn string

effectivedate string

]

• ]

[
  {
    "rc_name": "string",
    "rc_abbre": "string",
    "state": "string",
    "npa_nxx": [
      {
        "npa": "string",
        "nxx": "string",
        "ocn": "string",
        "effectivedate": "string"
      }
    ]
  }
]

400: Bad request when missing required parameters

application/json

• Schema
• Example (from schema)

Schema

success string

"false"

message string

you must provide a type parameter of 'zipcode' or 'city_state' and either 'city' and 'state' or 'zipcode' parameters

reasons string[]

{
  "success": "string",
  "message": "string",
  "reasons": [
    "string"
  ]
}

401: Unauthorized request

application/json

• Schema
• Example (from schema)

Schema

error string

Unauthorized request

{
  "error": "string"
}

Loading...