Get rate center suggestions

GET 
/geo/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 stringrequired

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

application/json

• Schema
• Example (from schema)

Schema

• 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

• ]

[
  {
    "state": "string",
    "city": "string",
    "type": "string",
    "rc_name": "string"
  }
]

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

application/json

• Schema
• Example (from schema)

Schema

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 string[]

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

401: Unauthorized request

application/json

• Schema
• Example (from schema)

Schema

error string

Unauthorized request

{
  "error": "string"
}

Loading...