Parameter Provinces by Country Guide

Latest Update Time: 2026-07-02 00:00:00

Use this API to retrieve all provinces (or states) for a specific country.

See the Parameter Introduction for base URL, authentication, and required headers.

Endpoint

GET https://ppapi.qima.com/parameter/v2/country/{countryId}/provinces

Prerequisites

A countryId obtained from Get All Countries or Search Countries

Path Parameters

Parameter	Required	Description
`countryId`	Yes	Country ID, from Get All Countries or Search Countries.

Query Parameters

Parameter	Required	Description
`refresh`	No	Send `false` (default) to use the server cache, or `true` to force a fresh lookup.

Request Example

curl --location --request GET 'https://ppapi.qima.com/parameter/v2/country/23424781/provinces' \
  --header 'Ai-Api-Access-Token: {your api access token}' \
  --header 'Ai-User-Id: {your user ID}' \
  --header 'Authorization: Bearer {your token}' \
  --header 'Referer: https://preprodmy.qima.com/'

Successful Response

The example below requested countryId=23424781 (China) — the response is trimmed to 2 of many provinces.

{
    "message": null,
    "content": [
        { "label": "Anhui", "value": "12578022" },
        { "label": "Beijing", "value": "12578011" }
    ]
}

Response Field Notes

Field	Notes
`content[].label`	Province/state display name.
`content[].value`	The province ID. Use this as `supplierProvinceID`/`factoryProvinceID`, or pass it to Search Cities in a Province.

Common Errors

See common authentication errors for 401 and 403 responses.

Next Steps

Use a province's value to search for cities within it.

Documents