Skip to main content
GET
List of states
payload.state takes the code of one of these states. The list is the 50 US states and DC; any other country returns an empty array. See Regions and location for the engines that take state and what it adds to a task’s price. The endpoint needs no API key. The list changes rarely, so fetch it at start-up and cache it. The answer is a bare array, as in Cloro, and it carries Cache-Control: public, max-age=3600.

Query Parameters

country
string
required

ISO 3166-1 alpha-2 country code, case-insensitive. Only US returns states.

Required string length: 2
Pattern: ^[A-Za-z]{2}$

Response

The states, in alphabetical order of name.

code
string
required

USPS two-letter code, the value payload.state takes.

Example:

"CA"

name
string
required
Example:

"California"