Get state/province list

GET

/api/v1/service/ports/state

Returns the available states or provinces for the specified country. Use the same proxy type for each step of the location lookup.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

An array of states or provinces. The array is empty when the country has no matching locations.

Bodyapplication/json

🟠400

🟠401

🟠403

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/service/ports/state?type=&countryId=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "data": [
        {
            "regionId": 0,
            "value": "FL",
            "label": "Florida",
            "property1": "string",
            "property2": "string"
        }
    ],
    "err": false,
    "msg": "SUCCESS",
    "code": 200
}

Modified at 2026-11-03 02:39:00

Get country list

Get city list