BBB API endpoint
Returns the complete current country and region list from BBB's public local directory. Use the returned region code with bbb-local-bbbs.
/bbb/regionsQuery parameters: none.
Returns the complete country and region catalog currently linked from BBB’s public local directory. Country codes are us and ca. Use the returned region codes with bbb-local-bbbs; do not infer region codes from ISO lists.
| Field | Filled in, of 2 checked | Values in the sample |
|---|---|---|
| code | 2 | |
| name | 2 | “United States” and 1 other value |
| regions | 2 | median 12 entries |
| Parameter | Type | Required | Default | Description | Example |
|---|---|---|---|---|---|
| x-api-key (header) | string | Yes | API key required |
curl -X GET "https://api.crawlora.net/api/v1/bbb/regions" \ -H "x-api-key: $CRAWLORA_API_KEY"
{
"code": 200,
"msg": "OK",
"data": {
"countries": [
{
"code": "us",
"name": "United States",
"regions": [
{
"code": "tx",
"name": "Texas",
"url": "https://www.bbb.org/about/find-your-local-bbb/us/tx"
}
]
},
{
"code": "ca",
"name": "Canada",
"regions": [
{
"code": "bc",
"name": "British Columbia",
"url": "https://www.bbb.org/about/find-your-local-bbb/ca/bc"
}
]
}
]
}
}Request schema
No body schema
Response schema
#/definitions/bbbdirectory.regionsResponseDoc
| Field | Type | Required | Enum | Bounds | Example | Description |
|---|---|---|---|---|---|---|
| code | integer | No | 200 | |||
| data | bbbdirectory.RegionsResponse | No | ||||
| data.countries | array | No | ||||
| data.countries[].code | string | No | us | |||
| data.countries[].name | string | No | United States | |||
| data.countries[].regions | array | No | ||||
| data.countries[].regions[].code | string | No | tx | |||
| data.countries[].regions[].name | string | No | Texas | |||
| data.countries[].regions[].url | string | No | https://www.bbb.org/about/find-your-local-bbb/us/tx | |||
| msg | string | No | OK |
| Status | Description | Schema |
|---|---|---|
| 500 | Internal Server Error | #/definitions/app.Response |
| 503 | Service Unavailable | #/definitions/app.Response |
Use environment variables for secrets and keep Crawlora API keys server-side.
curl -X GET "https://api.crawlora.net/api/v1/bbb/regions" \
-H "x-api-key: $CRAWLORA_API_KEY"