SIsignalshq
CLIENT

Get Cities by States

Retrieve all cities for a specific state using the state's two-letter code with pagination, sorting, and search capabilities.

get/internal/api/clients/state/cities

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Query parameters

state_codestring required

2 letter state code

pageinteger

Page number (1-based)

page_sizeinteger

Number of items per page (max 2000)

sort_bystring nullable

Field to sort by (name only)

sort_order'asc' | 'desc'

Sort order enumeration

Sort order

search_querystring nullable

Search term

Response

Successful Response

state_codestring required

Two-letter state code

state_namestring required

Full name of the state

countinteger required

Total number of cities in the state

Example response

{
  "cities": [
    {
      "name": "New York"
    },
    {
      "name": "Buffalo"
    }
  ],
  "count": 100,
  "meta": {
    "page": 1,
    "page_size": 20,
    "total_count": 100,
    "total_pages": 5
  },
  "state_code": "NY",
  "state_name": "New York"
}

Changes

No recorded changes to this operation across all 1 revision of this API.