SHshovels
States

Search States

Changed on

Searches US states by abbreviation or name. Exact abbreviation matches come first, then exact name matches, then other matches. Each group is ordered by state abbreviation.

get/states/search

Request

  • Base URL
    https://api.shovels.ai/v2
  • Auth
    API key in header X-API-Key

Query parameters

qstring required

The name to search for in the state fields.

cursorstring nullable

Continuation cursor containing the match rank and state ID.

sizeinteger

Response

A list of states that match the search term.

sizeinteger required

The number of items returned in the response.

next_cursorstring nullable required

The cursor for retrieving the next page of results.

Changes

  • 685b8866c451Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status