Search City Codes

Look up Parvenu city slug codes by name. Free helper for /company_search.

Search City Codes

POST /search_company_cities

Free — no credits are used. Resolve city_codes values for Company Search.

Headers

Name	Value
Content-Type	application/json

Body

Name	Type	Description
api_key	string	Your API Key.
search	string	Text to match against city names.

Response

The rows are under data. See Response Format for the fields every endpoint returns.

Field	Description
code	The slug to pass in city_codes.
name	The city name this slug matches.

total is the number of matches returned.

Example

Input

{
  "api_key": "your_api_key",
  "search": "new york"
}

Output

{
  "status": "success",
  "data": [
    { "code": "new-york|new-york|us", "name": "New York" },
    { "code": "west-new-york|new-jersey|us", "name": "West New York" },
    { "code": "new-york|florida|us", "name": "New York" }
  ],
  "credits_used": 0,
  "credits_remaining": 4823,
  "total": 3,
  "success": true
}