Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

API key. Format: Token

Query Parameters

category
integer

Category ID to filter.

countries
string[]

Country alpha-2 codes to export.

export_format
enum<string>

Output format: 'excel' (default), 'csv', or 'xlsx'.

Available options:
csv,
excel,
xlsx
include_additional_fields
enum<boolean>

Set to 'true' to append coordinates, rating, review count, claimed status, opening hours, and business status to the export. Defaults to 'false'.

Available options:
false,
true
include_closed_businesses
enum<boolean>

Set to 'true' to include permanently closed businesses in the search and export. Defaults to 'false'.

Available options:
false,
true

Response

status
string
required

'processing' on success, 'error' on failure.

validation_code
string
required

Machine-readable status code: 'processing_started', 'no_leads_found', 'insufficient_credits'.

search_id
integer

ID to poll download status. Only present when status='processing'.

lead_count
integer

Number of leads being exported (= credits deducted). Present on success and no_leads_found.