List dynamic proxy regions

GET /open-api/v1/dynamic/regions

Base URL: https://api.ipfbs.com/gin.

Authentication

Send your key in the X-API-Key request header.

Path and query parameters

Field	In	Type	Required	Constraints	Meaning
level	query	string	Yes	enum: COUNTRY, PROVINCE, CITY	Level.
parent_code	query	string	No	minLength: 1; maxLength: 64	Parent code.

Request example

curl --request GET \
  --url 'https://api.ipfbs.com/gin/open-api/v1/dynamic/regions?level=COUNTRY' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: <YOUR_API_KEY>'

Success response data

Responses use code, msg, data, and next. HTTP 200 can also contain a nonzero business error code; check code first.

Field	Type	Required	Constraints	Meaning
data	object[]	No	—	Data.
data[].region_code	string	No	—	Region code returned by the regions endpoint.
data[].name	string	No	—	Name.
data[].level	string	No	enum: COUNTRY, PROVINCE, CITY	Level.
data[].parent_code	string	No	—	Parent code.
data[].has_children	boolean	No	—	Has children.

Related conventions

Request conventions · Response structure · Error codes · API reference index