Datasets

Facet the SEC companies dataset

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.

get/datasets/sec-companies/facets

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/datasets/sec-companies/facets
  • Auth: API key in header x-api-key

Query parameters

facet'sic' | 'sic_description' | 'exchange' | 'state_of_incorporation' | 'entity_type' | 'reporting_currency' | 'revenue_band' | 'forms_filed' required

Facet enum: sic, sic_description, exchange, state_of_incorporation, entity_type, reporting_currency, revenue_band, forms_filed

qstring

Full-text query over the company name, or an exact ticker match, max 256 characters

tickerstring

Exact ticker filter (case-insensitive), max 32 characters

sicstring

Exact SIC industry-code filter, max 32 characters

exchangestring

Exact exchange filter as reported by EDGAR, max 64 characters

state_of_incorporationstring

Exact state/country-of-incorporation filter, max 32 characters

entity_typestring

Exact entity-type filter, max 64 characters

reporting_currencystring

Exact reporting-currency filter, ISO-4217 code, e.g. USD, JPY, EUR

has_financialsboolean

When true, keep only companies that have XBRL financial statements

min_revenuenumber

Minimum latest-annual revenue in USD (normalized at reference rates), 0 or greater

form_filedstring

Exact form-type filter, e.g. 10-K, 8-K

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.