Look Up Rate Center

Fetch up to 50 locations and ratecenters using the query parameter

Get rate center suggestions

Fetch up to 50 locations and ratecenters using the query parameter. Results will contain city/state matches first and then rate center matches.

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

Request
query Parameters
query
required
string

Search term must be at least three characters long

Responses
200

Success. The response will be an array of CityResult and RatecenterResult objects or the NoResults object

Response Schema: application/json
Array
state
string

two character state

city
string

Locality of the city matched

type
string

Either "location" or "rate_center"

rc_name
string

Ratecenter name

400

Bad request when missing query parameter or query length is less than three characters

Response Schema: application/json
success
string

"false"

message
string

you must provide a query in order to get typeahead suggestions

your query must be 3 characters or more to get typeahead suggestions

reasons
Array of strings
401

Unauthorized request

Response Schema: application/json
error
string

Unauthorized request

get/geo/suggestions
Request samples 
Response samples 
application/json
[
  • {
    • "state": "string",
    • "city": "string",
    • "type": "string",
    • "rc_name": "string"
    }
]
Get rate center by 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
required
string
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.


Response Schema: application/json
 Array 
rc_name
string
Ratecenter name


 
rc_abbre
string
Ratecenter abbreviation


 
state
string
State


 
Array of objects
 
400
Bad request when missing required parameters


Response Schema: application/json
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
Array of strings
 
401
Unauthorized request


Response Schema: application/json
error
string
Unauthorized request


 
get/geo/location
Request samples 
Response samples 
application/json
[
  • {
    • "rc_name": "string",
    • "rc_abbre": "string",
    • "state": "string",
    • "npa_nxx": [
      • {
        • "npa": "string",
        • "nxx": "string",
        • "ocn": "string",
        • "effectivedate": "string"
        }
      ]
    }
]
Get rate center by name
Lookup rate centers using rate center name and state.Only exact matches are supported.


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


Request 
query Parameters
rc_name
required
string
Rate center name


 
state
required
string
State of the rate center


 
Responses 
200
Success. The response will be an array of RateCenterResult objects.


Response Schema: application/json
 Array 
rc_name
string
Ratecenter name


 
rc_abbre
string
Ratecenter abbreviation


 
state
string
State


 
Array of objects
 
400
Bad request when missing required parameters


Response Schema: application/json
success
string
"false"


 
message
string
you must provide the parameters rc_name and state


 
reasons
Array of strings
 
401
Unauthorized request


Response Schema: application/json
error
string
Unauthorized request


 
get/geo/rc
Request samples 
Response samples 
application/json
[
  • {
    • "rc_name": "string",
    • "rc_abbre": "string",
    • "state": "string",
    • "npa_nxx": [
      • {
        • "npa": "string",
        • "nxx": "string",
        • "ocn": "string",
        • "effectivedate": "string"
        }
      ]
    }
]
Get rate center by number
Lookup rate centers that contain a number that match a npa, nxx pair. Wildcards as (*) may be used for nxx.


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


Request 
query Parameters
npa
required
string
npa


 
nxx
required
string
nxx


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


Response Schema: application/json
 Array 
rc_name
string
Ratecenter name


 
rc_abbre
string
Ratecenter abbreviation


 
state
string
State


 
Array of objects
 
400
Bad request when missing query parameter or query length is less than three characters


Response Schema: application/json
success
string
"false"


 
message
string
you must provide both NPA and NXX parameters to do this type of lookup; NPA and NXX must both be 3-digit numbers, * wildcards are allowed"


 
reasons
Array of strings
 
401
Unauthorized request


Response Schema: application/json
error
string
Unauthorized request


 
get/geo/supplemental
Request samples 
Response samples 
application/json
[
  • {
    • "rc_name": "string",
    • "rc_abbre": "string",
    • "state": "string",
    • "npa_nxx": [
      • {
        • "npa": "string",
        • "nxx": "string"
        }
      ]
    }
]