Docs menu

Datasets API endpoint

Facet the SEC companies dataset API

Use Crawlora's Facet the SEC companies dataset API to search or inspect stored structured datasets as JSON. This page includes request parameters, cURL examples, response schema, validation behavior, credit cost, and a Playground link for testing before integration. Dataset endpoints read indexed records and do not apply proxy routing.

GETapiKey1 credit/requestDatasetsdatasets.secCompaniesFacetResponseDoc/datasets/sec-companies/facets

Endpoint facts

Method: GET
API path: /datasets/sec-companies/facets
Auth: apiKey
Credits: 1 credit/request
Platform: Datasets
Response schema: #/definitions/datasets.secCompaniesFacetResponseDoc

Overview

Returns terms-aggregation counts for one facet of the SEC companies dataset, scoped to the same filters as search. Facet enum: `sic`, `sic_description`, `exchange`, `state_of_incorporation`, `entity_type`, `reporting_currency`, `revenue_band`, `forms_filed`. `revenue_band` buckets latest-annual revenue into: `unknown`, `under_1m`, `1m_10m`, `10m_100m`, `100m_1b`, `1b_10b`, `over_10b`. Developers commonly use this endpoint for repeatable dataset search, filtering, facets, local business enrichment, analytics, exports, and internal tools that need structured records beyond the limited manual refinement available in the Google Maps app. Authentication uses the x-api-key header, usage is metered with the credit cost shown on this page, and the request does not trigger live scraping or proxy routing.

Stored structured dataset search API Try Facet the SEC companies dataset API in Playground Crawlora API pricing Datasets API documentation

Request parameters

Request parameters are generated from the active endpoint catalog. Dataset parameters filter, page, facet, or locate stored structured records; they do not configure a live scraper or proxy path.

Parameter	Type	Required	Description
facet	string	Yes	Facet enum: sic, sic_description, exchange, state_of_incorporation, entity_type, reporting_currency, revenue_band, forms_filed Allowed values: sic, sic_description, exchange, state_of_incorporation, entity_type, reporting_currency, revenue_band, forms_filed
q	string	No	Full-text query over the company name, or an exact ticker match, max 256 characters
ticker	string	No	Exact ticker filter (case-insensitive), max 32 characters
sic	string	No	Exact SIC industry-code filter, max 32 characters
exchange	string	No	Exact exchange filter as reported by EDGAR, max 64 characters
state_of_incorporation	string	No	Exact state/country-of-incorporation filter, max 32 characters
entity_type	string	No	Exact entity-type filter, max 64 characters
reporting_currency	string	No	Exact reporting-currency filter, ISO-4217 code, e.g. USD, JPY, EUR
has_financials	boolean	No	When true, keep only companies that have XBRL financial statements
min_revenue	number	No	Minimum latest-annual revenue in USD (normalized at reference rates), 0 or greater
form_filed	string	No	Exact form-type filter, e.g. 10-K, 8-K
x-api-key (header)	string	Yes	API key required

cURL example

curl -X GET "https://api.crawlora.net/api/v1/datasets/sec-companies/facets?facet=sic&q=coffee&has_financials=true" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Authentication

Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.

Billing

Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.

Credit cost: 1 credit/request
Charged response: Successful 2xx responses

Plan	Price	Included credits	Daily cap	Rate limit	Overage
Free	$0/mo	2,000	500 daily credits	5/min	No overage
Starter	$9/mo	20,000	5,000 daily credits	15/min	$0.75/1,000 overage credits when enabled
Growth	$29/mo	100,000	25,000 daily credits	45/min	$0.45/1,000 overage credits when enabled
Pro	$79/mo	400,000	No daily cap	120/min	$0.30/1,000 overage credits
Business	$199/mo	1,200,000	No daily cap	300/min	$0.20/1,000 overage credits
Enterprise	$499/mo	5,000,000	No daily cap	1,000/min	$0.12/1,000 overage credits

Infrastructure behavior

This endpoint reads stored indexed dataset records. It does not execute a live upstream Google Maps request, browser session, or proxy-routed scraping job.

Data source: stored Crawlora dataset records
Proxy strategy: no proxy routing is applied
Browser rendering: not used for dataset search or lookup requests
Live scraping: not triggered by dataset list, search, nearby, facet, or detail endpoints
Validation: invalid filters, coordinates, pagination, and enum values return documented errors
Billing: credits are charged only for successful 2xx responses
Observability: responses include request context where available

Response behavior

- Returns an empty `items` array (not an error) when the dataset has no data yet. - Invalid `facet` values return the standard invalid params envelope. Example response: ```json { "code": 200, "msg": "OK", "data": { "dataset": "sec-companies", "facet": "sic_description", "items": [ { "value": "Electronic Computers", "count": 18 }, { "value": "Pharmaceutical Preparations", "count": 152 }, { "value": "State Commercial Banks", "count": 640 } ] } } ```

Catalog quality warnings

missing example for required query param: facet

Error behavior

Crawlora does not silently return invalid dataset search results when filters, pagination, coordinates, or stored record lookups cannot be satisfied.

Status	Common failure case
400	Invalid input, missing required parameter, invalid enum, bad coordinate pair, or result window beyond the dataset limit
404	Requested stored dataset item is not present
429	Plan or endpoint rate limit exceeded
500	Internal dataset query or storage error

When possible, Crawlora returns structured error context so your integration can adjust filters, page size, location inputs, or lookup identifiers.

Failure responses

Status	Description	Schema
400	Bad Request	#/definitions/app.Response
429	Too Many Requests	#/definitions/app.Response
500	Internal Server Error	#/definitions/app.Response

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "dataset": "sec-companies",
    "facet": "sic_description",
    "items": [
      {
        "value": "Electronic Computers",
        "count": 18
      },
      {
        "value": "Pharmaceutical Preparations",
        "count": 152
      },
      {
        "value": "State Commercial Banks",
        "count": 640
      }
    ]
  }
}

Request schema

No body schema

Response schema

#/definitions/datasets.secCompaniesFacetResponseDoc

Field	Type	Required	Example
code	integer	No	200
data	datasets.SecCompanyFacetResponse	No
data.dataset	string	No
data.facet	string	No
data.items	array	No
data.items[].count	integer	No
data.items[].value	string	No
msg	string	No	OK

Code examples

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

curl -X GET "https://api.crawlora.net/api/v1/datasets/sec-companies/facets?facet=sic&q=coffee&has_financials=true" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Responsible public web data workflows

Crawlora is designed for responsible structured public web data workflows. Customers are responsible for using Crawlora in compliance with applicable laws, third-party rights, target-platform rules, and Crawlora terms.

Read Crawlora terms

More Datasets endpoint docs Stored structured dataset search API Crawlora API pricing Try Facet the SEC companies dataset API in Playground Stored Datasets List API documentation Airbnb Markets Dataset Facets API documentation Airbnb Markets Dataset Country API documentation Nearby Airbnb Markets Dataset API documentation Airbnb Markets Dataset Search API documentation Facet Apple Podcasts shows dataset API documentation

Open in Playground Back to group

Docs menu

Datasets API endpoint

Facet the SEC companies dataset API

GETapiKey1 credit/requestDatasetsdatasets.secCompaniesFacetResponseDoc/datasets/sec-companies/facets

Endpoint facts

Method: GET
API path: /datasets/sec-companies/facets
Auth: apiKey
Credits: 1 credit/request
Platform: Datasets
Response schema: #/definitions/datasets.secCompaniesFacetResponseDoc

Overview

Stored structured dataset search API Try Facet the SEC companies dataset API in Playground Crawlora API pricing Datasets API documentation

Request parameters

Request parameters are generated from the active endpoint catalog. Dataset parameters filter, page, facet, or locate stored structured records; they do not configure a live scraper or proxy path.

Parameter	Type	Required	Description
facet	string	Yes	Facet enum: sic, sic_description, exchange, state_of_incorporation, entity_type, reporting_currency, revenue_band, forms_filed Allowed values: sic, sic_description, exchange, state_of_incorporation, entity_type, reporting_currency, revenue_band, forms_filed
q	string	No	Full-text query over the company name, or an exact ticker match, max 256 characters
ticker	string	No	Exact ticker filter (case-insensitive), max 32 characters
sic	string	No	Exact SIC industry-code filter, max 32 characters
exchange	string	No	Exact exchange filter as reported by EDGAR, max 64 characters
state_of_incorporation	string	No	Exact state/country-of-incorporation filter, max 32 characters
entity_type	string	No	Exact entity-type filter, max 64 characters
reporting_currency	string	No	Exact reporting-currency filter, ISO-4217 code, e.g. USD, JPY, EUR
has_financials	boolean	No	When true, keep only companies that have XBRL financial statements
min_revenue	number	No	Minimum latest-annual revenue in USD (normalized at reference rates), 0 or greater
form_filed	string	No	Exact form-type filter, e.g. 10-K, 8-K
x-api-key (header)	string	Yes	API key required

cURL example

curl -X GET "https://api.crawlora.net/api/v1/datasets/sec-companies/facets?facet=sic&q=coffee&has_financials=true" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Authentication

Send your scraping API key in the x-api-key header. Use the console API Keys page to rotate or select the active key.

Billing

Endpoint usage is metered in credits. The plan prices, included credits, limits, and overage rates below match the active backend billing configuration.

Credit cost: 1 credit/request
Charged response: Successful 2xx responses

Plan	Price	Included credits	Daily cap	Rate limit	Overage
Free	$0/mo	2,000	500 daily credits	5/min	No overage
Starter	$9/mo	20,000	5,000 daily credits	15/min	$0.75/1,000 overage credits when enabled
Growth	$29/mo	100,000	25,000 daily credits	45/min	$0.45/1,000 overage credits when enabled
Pro	$79/mo	400,000	No daily cap	120/min	$0.30/1,000 overage credits
Business	$199/mo	1,200,000	No daily cap	300/min	$0.20/1,000 overage credits
Enterprise	$499/mo	5,000,000	No daily cap	1,000/min	$0.12/1,000 overage credits

Infrastructure behavior

This endpoint reads stored indexed dataset records. It does not execute a live upstream Google Maps request, browser session, or proxy-routed scraping job.

Data source: stored Crawlora dataset records
Proxy strategy: no proxy routing is applied
Browser rendering: not used for dataset search or lookup requests
Live scraping: not triggered by dataset list, search, nearby, facet, or detail endpoints
Validation: invalid filters, coordinates, pagination, and enum values return documented errors
Billing: credits are charged only for successful 2xx responses
Observability: responses include request context where available

Response behavior

Catalog quality warnings

missing example for required query param: facet

Error behavior

Crawlora does not silently return invalid dataset search results when filters, pagination, coordinates, or stored record lookups cannot be satisfied.

Status	Common failure case
400	Invalid input, missing required parameter, invalid enum, bad coordinate pair, or result window beyond the dataset limit
404	Requested stored dataset item is not present
429	Plan or endpoint rate limit exceeded
500	Internal dataset query or storage error

When possible, Crawlora returns structured error context so your integration can adjust filters, page size, location inputs, or lookup identifiers.

Failure responses

Status	Description	Schema
400	Bad Request	#/definitions/app.Response
429	Too Many Requests	#/definitions/app.Response
500	Internal Server Error	#/definitions/app.Response

Example JSON response

{
  "code": 200,
  "msg": "OK",
  "data": {
    "dataset": "sec-companies",
    "facet": "sic_description",
    "items": [
      {
        "value": "Electronic Computers",
        "count": 18
      },
      {
        "value": "Pharmaceutical Preparations",
        "count": 152
      },
      {
        "value": "State Commercial Banks",
        "count": 640
      }
    ]
  }
}

Request schema

No body schema

Response schema

#/definitions/datasets.secCompaniesFacetResponseDoc

Field	Type	Required	Example
code	integer	No	200
data	datasets.SecCompanyFacetResponse	No
data.dataset	string	No
data.facet	string	No
data.items	array	No
data.items[].count	integer	No
data.items[].value	string	No
msg	string	No	OK

Code examples

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

curl -X GET "https://api.crawlora.net/api/v1/datasets/sec-companies/facets?facet=sic&q=coffee&has_financials=true" \
  -H "x-api-key: $CRAWLORA_API_KEY"

Responsible public web data workflows

Read Crawlora terms

Open in Playground Back to group

Facet the SEC companies dataset API

Endpoint facts

Overview

Request parameters

cURL example

Authentication

Billing

Infrastructure behavior

Response behavior

Catalog quality warnings

Error behavior

Failure responses

Example JSON response

Code examples

Responsible public web data workflows

Related

Facet the SEC companies dataset API

Endpoint facts

Overview

Request parameters

cURL example

Authentication

Billing

Infrastructure behavior

Response behavior

Catalog quality warnings

Error behavior

Failure responses

Example JSON response

Code examples

Responsible public web data workflows

Related