Docs menu

BBB API endpoint

Local BBB chapter profile API

Returns public chapter profile details including office locations and hours, service territory, supported languages, and upcoming public events. news_url is the chapter's constructed newsroom route. When BBB publishes a program tile linking to a recognized newsroom path, published_news_url and its descriptive published_news_title are also returned. Use a canonical chapter URL from bbb-local-bbbs or a business record's local_bbb_url.

GETapiKey2 credits/requestBBBbbbdirectory.localBBBResponseDoc/bbb/local-bbb

Endpoint facts

Method: GET
API path: /bbb/local-bbb
Auth: apiKey
Credits: 2 credits/request
Charged on: Successful 2xx responses only
Platform: BBB
Response schema: #/definitions/bbbdirectory.localBBBResponseDoc

BBB Scraper API Try Local BBB chapter profile API in Playground BBB API documentation

How this endpoint behaves

Query parameters:

url (required): a canonical https://www.bbb.org/local-bbb/<slug> URL from bbb-local-bbbs or a BBB business record’s local_bbb_url.

Returns public chapter profile details, visible office locations and hours, service territory, supported languages, and upcoming public event links. news_url is the constructed chapter newsroom, accepted by bbb_news and bbb_news_topics. If BBB publishes a program tile whose link path is a newsroom route accepted by bbb_news, published_news_url and the tile's descriptive published_news_title are also returned. The tile title does not determine whether its link is a newsroom. When multiple tiles match, the lowest numeric BBB priority is used, with BBB's tile order breaking ties. Both published fields are omitted when no matching tile is present. The URL must use the canonical BBB host and chapter path; other hosts and paths are rejected.

Example request: /api/v1/bbb/local-bbb?url=https%3A%2F%2Fwww.bbb.org%2Flocal-bbb%2Fbbb-serving-the-heart-of-texas

Some chapter profiles also include fields like published_news_url and published_news_title. For example, BBB Upstate NY publishes the title News and Events linking to https://www.bbb.org/us/ny/buffalo/news. These fields are available only on bbb-local-bbb; bbb-local-bbbs does not include the chapter program tiles.

Sampled response

Request, 14 Oct 2026: GET /bbb/local-bbb?url=https%3A%2F%2Fwww.bbb.org%2Flocal-bbb%2Fbbb-serving-the-heart-of-texas
Items in events: 3
Fields filled in every checked item: 5

Field	Filled in, of 3 checked	Values in the sample
title	3	“She Means Business: Building the Plane While Flying” and 2 other values
url	3	bbb.org
summary	3	median 153 characters
starts_at	3	2026-10-15 to 2026-10-23
ends_at	3	2026-10-15 to 2026-10-23

Request parameters

Parameter	Type	Required	Default	Description	Example
url	string	Yes		Canonical BBB chapter URL from bbb-local-bbbs or a business record's local_bbb_url	https://www.bbb.org/local-bbb/bbb-serving-the-heart-of-texas
x-api-key (header)	string	Yes		API key required

cURL example

curl -X GET "https://api.crawlora.net/api/v1/bbb/local-bbb?url=https%3A%2F%2Fwww.bbb.org%2Flocal-bbb%2Fbbb-serving-the-heart-of-texas" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "id": "0825",
    "name": "BBB Heart of Texas",
    "url": "https://www.bbb.org/local-bbb/bbb-serving-the-heart-of-texas",
    "news_url": "https://www.bbb.org/local-bbb/bbb-serving-the-heart-of-texas/news",
    "open_to_public": true,
    "tagline": "serving the communities in and around Austin, Bryan, Corpus Christi, Fort Worth, Midland, San Antonio and Waco",
    "languages": [
      "English",
      "Spanish"
    ],
    "service_territory": [
      "TX"
    ],
    "offices": [
      {
        "type": "Primary",
        "is_primary": true,
        "address": {
          "state_province": "TX",
          "country": "US"
        },
        "contact": {},
        "office_hours": [
          "Support services are now available exclusively online and by phone. We have suspended walk-in services yet we remain committed to serving you effectively and efficiently."
        ],
        "phone_hours": [
          "Monday - Friday 9 a.m. - 4 p.m."
        ]
      }
    ],
    "events": [
      {
        "title": "Corpus Christi Shred Day",
        "url": "https://www.bbb.org/article/events/36815-corpus-christi-shred-day",
        "starts_at": "2026-10-09T14:00:33Z"
      }
    ]
  }
}

Request schema

No body schema

Response schema

#/definitions/bbbdirectory.localBBBResponseDoc

Field	Type	Required	Example	Description
code	integer	No	200
data	bbbdirectory.LocalBBBResponse	No
data.about	string	No
data.events	array	No
data.events[].ends_at	string	No
data.events[].starts_at	string	No
data.events[].summary	string	No
data.events[].title	string	No
data.events[].url	string	No
data.id	string	No	0825
data.languages	array	No	English,Spanish
data.name	string	No	BBB Heart of Texas
data.news_url	string	No	https://www.bbb.org/local-bbb/bbb-serving-the-heart-of-texas/news	The chapter's own newsroom; pass it to bbb-news or bbb-news-topics.
data.offices	array	No
data.offices[].address	bbbdirectory.OfficeAddress	No
data.offices[].address.city	string	No
data.offices[].address.country	string	No
data.offices[].address.county	string	No
data.offices[].address.line1	string	No
data.offices[].address.line2	string	No
data.offices[].address.location_name	string	No
data.offices[].address.postal_code	string	No
data.offices[].address.state_province	string	No
data.offices[].contact	bbbdirectory.OfficeContact	No
data.offices[].contact.email	string	No
data.offices[].contact.fax_number	string	No
data.offices[].contact.phone_number	string	No
data.offices[].formatted_address	string	No	600 Beacon Parkway West, Suite 900, Birmingham, AL 35209
data.offices[].is_primary	boolean	No	true
data.offices[].jurisdictions	array	No
data.offices[].office_hours	array	No
data.offices[].phone_hours	array	No
data.offices[].type	string	No	Primary
data.open_to_public	boolean	No	true
data.published_news_title	string	No	News and Events
data.published_news_url	string	No	https://www.bbb.org/us/tx/amarillo/news	The first BBB-published program tile that links to a newsroom route. It is absent when the chapter does not publish a matching tile.
data.service_territory	array	No
data.tagline	string	No
data.url	string	No	https://www.bbb.org/local-bbb/bbb-serving-the-heart-of-texas
msg	string	No	OK

Failure responses

Status	Description	Schema
400	Bad Request	#/definitions/app.Response
404	Not Found	#/definitions/app.Response
500	Internal Server Error	#/definitions/app.Response
503	Service Unavailable	#/definitions/app.Response

Code examples

Use environment variables for secrets and keep Crawlora API keys server-side.

curl -X GET "https://api.crawlora.net/api/v1/bbb/local-bbb?url=https%3A%2F%2Fwww.bbb.org%2Flocal-bbb%2Fbbb-serving-the-heart-of-texas" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Shared guides

Authentication Errors and retries Rate limits and credits Pricing Acceptable use

More BBB endpoint docs BBB Scraper API Get a BBB article API documentation BBB Business API documentation BBB Business Complaints API documentation BBB Business More Info API documentation BBB Business Reviews API documentation BBB Category API documentation

Open in Playground Back to group

Docs menu

BBB API endpoint

Local BBB chapter profile API

GETapiKey2 credits/requestBBBbbbdirectory.localBBBResponseDoc/bbb/local-bbb

Endpoint facts

Method: GET
API path: /bbb/local-bbb
Auth: apiKey
Credits: 2 credits/request
Charged on: Successful 2xx responses only
Platform: BBB
Response schema: #/definitions/bbbdirectory.localBBBResponseDoc

BBB Scraper API Try Local BBB chapter profile API in Playground BBB API documentation

How this endpoint behaves

Query parameters:

url (required): a canonical https://www.bbb.org/local-bbb/<slug> URL from bbb-local-bbbs or a BBB business record’s local_bbb_url.

Example request: /api/v1/bbb/local-bbb?url=https%3A%2F%2Fwww.bbb.org%2Flocal-bbb%2Fbbb-serving-the-heart-of-texas

Sampled response

Request, 14 Oct 2026: GET /bbb/local-bbb?url=https%3A%2F%2Fwww.bbb.org%2Flocal-bbb%2Fbbb-serving-the-heart-of-texas
Items in events: 3
Fields filled in every checked item: 5

Field	Filled in, of 3 checked	Values in the sample
title	3	“She Means Business: Building the Plane While Flying” and 2 other values
url	3	bbb.org
summary	3	median 153 characters
starts_at	3	2026-10-15 to 2026-10-23
ends_at	3	2026-10-15 to 2026-10-23

Request parameters

Parameter	Type	Required	Default	Description	Example
url	string	Yes		Canonical BBB chapter URL from bbb-local-bbbs or a business record's local_bbb_url	https://www.bbb.org/local-bbb/bbb-serving-the-heart-of-texas
x-api-key (header)	string	Yes		API key required

cURL example

curl -X GET "https://api.crawlora.net/api/v1/bbb/local-bbb?url=https%3A%2F%2Fwww.bbb.org%2Flocal-bbb%2Fbbb-serving-the-heart-of-texas" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "id": "0825",
    "name": "BBB Heart of Texas",
    "url": "https://www.bbb.org/local-bbb/bbb-serving-the-heart-of-texas",
    "news_url": "https://www.bbb.org/local-bbb/bbb-serving-the-heart-of-texas/news",
    "open_to_public": true,
    "tagline": "serving the communities in and around Austin, Bryan, Corpus Christi, Fort Worth, Midland, San Antonio and Waco",
    "languages": [
      "English",
      "Spanish"
    ],
    "service_territory": [
      "TX"
    ],
    "offices": [
      {
        "type": "Primary",
        "is_primary": true,
        "address": {
          "state_province": "TX",
          "country": "US"
        },
        "contact": {},
        "office_hours": [
          "Support services are now available exclusively online and by phone. We have suspended walk-in services yet we remain committed to serving you effectively and efficiently."
        ],
        "phone_hours": [
          "Monday - Friday 9 a.m. - 4 p.m."
        ]
      }
    ],
    "events": [
      {
        "title": "Corpus Christi Shred Day",
        "url": "https://www.bbb.org/article/events/36815-corpus-christi-shred-day",
        "starts_at": "2026-10-09T14:00:33Z"
      }
    ]
  }
}

Request schema

No body schema

Response schema

#/definitions/bbbdirectory.localBBBResponseDoc

Field	Type	Required	Example	Description
code	integer	No	200
data	bbbdirectory.LocalBBBResponse	No
data.about	string	No
data.events	array	No
data.events[].ends_at	string	No
data.events[].starts_at	string	No
data.events[].summary	string	No
data.events[].title	string	No
data.events[].url	string	No
data.id	string	No	0825
data.languages	array	No	English,Spanish
data.name	string	No	BBB Heart of Texas
data.news_url	string	No	https://www.bbb.org/local-bbb/bbb-serving-the-heart-of-texas/news	The chapter's own newsroom; pass it to bbb-news or bbb-news-topics.
data.offices	array	No
data.offices[].address	bbbdirectory.OfficeAddress	No
data.offices[].address.city	string	No
data.offices[].address.country	string	No
data.offices[].address.county	string	No
data.offices[].address.line1	string	No
data.offices[].address.line2	string	No
data.offices[].address.location_name	string	No
data.offices[].address.postal_code	string	No
data.offices[].address.state_province	string	No
data.offices[].contact	bbbdirectory.OfficeContact	No
data.offices[].contact.email	string	No
data.offices[].contact.fax_number	string	No
data.offices[].contact.phone_number	string	No
data.offices[].formatted_address	string	No	600 Beacon Parkway West, Suite 900, Birmingham, AL 35209
data.offices[].is_primary	boolean	No	true
data.offices[].jurisdictions	array	No
data.offices[].office_hours	array	No
data.offices[].phone_hours	array	No
data.offices[].type	string	No	Primary
data.open_to_public	boolean	No	true
data.published_news_title	string	No	News and Events
data.published_news_url	string	No	https://www.bbb.org/us/tx/amarillo/news	The first BBB-published program tile that links to a newsroom route. It is absent when the chapter does not publish a matching tile.
data.service_territory	array	No
data.tagline	string	No
data.url	string	No	https://www.bbb.org/local-bbb/bbb-serving-the-heart-of-texas
msg	string	No	OK

Failure responses

Status	Description	Schema
400	Bad Request	#/definitions/app.Response
404	Not Found	#/definitions/app.Response
500	Internal Server Error	#/definitions/app.Response
503	Service Unavailable	#/definitions/app.Response

Code examples

Use environment variables for secrets and keep Crawlora API keys server-side.

curl -X GET "https://api.crawlora.net/api/v1/bbb/local-bbb?url=https%3A%2F%2Fwww.bbb.org%2Flocal-bbb%2Fbbb-serving-the-heart-of-texas" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Shared guides

Authentication Errors and retries Rate limits and credits Pricing Acceptable use

Open in Playground Back to group

Local BBB chapter profile API

Endpoint facts

How this endpoint behaves

Sampled response

Request parameters

cURL example

Example JSON response

Failure responses

Code examples

Shared guides

Related

Local BBB chapter profile API

Endpoint facts

How this endpoint behaves

Sampled response

Request parameters

cURL example

Example JSON response

Failure responses

Code examples

Shared guides

Related