Exports

Firm export

Export firm rows as json or csv using the same Firm type, financial and correlated role filters as firm search. CSV uses the fields order shown in the JSON response. Credits are charged by actual delivered rows. Requires the public_api_exports entitlement.

get/exports/firms

Request

  • Base URL: https://api.hackforddata.com/v1
  • URL: https://api.hackforddata.com/v1/exports/firms
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • API key in header Authorization
    • API key in cookie sessionid

Query parameters

financial.sec_regulated_aum_gte_usdnumber

SEC Form ADV regulated AUM at least this many USD.

financial.sec_regulated_aum_lte_usdnumber

SEC Form ADV regulated AUM at most this many USD.

financial.turnover_gte_gbpnumber

Latest annual-accounts turnover at least this many GBP.

financial.turnover_lte_gbpnumber

Latest annual-accounts turnover at most this many GBP.

firm_typestring

One or more comma-separated Firm type codes.

firm_type.categorystring

One or more comma-separated Firm type category codes.

firm_type.tagstring

Firm type tag code.

firm_type.tag_dimensionstring

Firm type tag dimension.

formatstring

Export format: json or csv. Defaults to json.

limitinteger

Maximum rows to export synchronously. Capped at 5000.

mifid_firmboolean

Filter by current official FCA UK MiFID register membership. Use true for members or false for FCA firms that are not members.

role.codestring

Comma-separated role codes, correlated with the other role filters.

role.source_authority'fca'

Role source authority. Public API v1 role rows come from FCA Extract.

role.start_fromstring date

Role start date on or after this YYYY-MM-DD date.

role.start_tostring date

Role start date on or before this YYYY-MM-DD date.

role.statusstring

Role status: current (default), previous or both.

Response

delivery_idstring uuid nullable
formatstring required
countinteger required
exported_countinteger required
limitinteger required
fieldsstring[] required
resultsobject[] required

Changes

No recorded changes to this operation across all 1 revision of this API.