ExtractionLocation Extraction API

BQ Location Extraction API

GET
/extraction/api/locations

All physical Locations associated with the Organization (headquarters, branches, legal and officer addresses), with USPS-standardized addresses and online review data. Up to 100 records per page.

Example: GET https://apigw.brightquery.com/extraction/api/locations?bq_id=100003273517&page=1

Authorization

ApiKeyAuth
x-api-key<token>

Your BrightQuery API key, sent in the x-api-key request header.

In: header

Query Parameters

bq_id*integer

Unique ID assigned by BrightQuery to the Organization. Mandatory.

page?integer

The page number to retrieve (default 1).

Range1 <= value
Default1

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/extraction/api/locations?bq_id=100003273517&page=1"
{  "status": 0,  "credit_balance": 0,  "data": {    "total": 0,    "size": 0,    "current_page": 0,    "next_page": 0,    "prev_page": 0,    "pages": 0,    "has_more": true,    "locations": [      {        "bq_location_id": "string",        "bq_id": "string",        "bq_company_name": "string",        "bq_ticker": "string",        "bq_website": "string",        "bq_location_name": "string",        "bq_location_type": "string",        "bq_location_class": "string",        "bq_location_address_line_1": "string",        "bq_location_address_line_2": "string",        "bq_location_address_city": "string",        "bq_location_address_state": "string",        "bq_location_address_state_name": "string",        "bq_location_address_zip5": "string",        "bq_location_address_zip9": "string",        "bq_location_address_zip_type": "string",        "bq_location_address_county_name": "string",        "bq_location_address_county_fips": "string",        "bq_location_address_country_name": "string",        "bq_location_address_country_code": "string",        "bq_location_address_rdi": "string",        "bq_location_address_latitude": "string",        "bq_location_address_longitude": "string",        "bq_location_address_dpv_match_code": "string",        "bq_location_address_building_default_indicator": "string",        "bq_location_address_cbsa_code": "string",        "bq_location_address_cbsa_name": "string",        "bq_location_address_cbsa_type": "string",        "bq_location_address_summary": "string",        "bq_location_phone_number": "string",        "bq_location_category": "string",        "bq_location_confidence_score": "string",        "bq_location_category_all": "string",        "bq_location_address1_congressional_district": "string",        "bq_location_online_reviews_count": "string",        "bq_location_avg_online_score": "string",        "bq_location_website": "string",        "bq_location_website_domain": "string",        "bq_location_active_indicator": "string",        "bq_location_headquarter_indicator": "string",        "bq_location_address_administrative_area": "string",        "bq_location_address_postal_code": "string",        "bq_location_address_postal_code_ext": "string",        "bq_location_address_country_code2": "string",        "bq_location_address_country_code3": "string",        "extracted_on": "string"      }    ]  }}