Skip to main content

FinancialReports API

Public-company filings across G20 markets and Europe. Authenticate every request with the X-API-Key header. Honor the X-RateLimit-Burst-Remaining response header.

Tiered access. L1 — metadata, company profiles, ISIC classifications, reference data, point-in-time audit trails. L2 — Markdown / JSON content, full-text search. L3 — standardized financial line items (income statement, balance sheet, cash-flow statement) per fiscal period, mapped to a single reusable taxonomy.

Base URL
https://api.financialreports.eu
Version
1.1.5
Auth
X-API-Key · Bearer JWT
Operations
46 endpoints · 12 resources

Filings

Endpoints for accessing company filings and their content.

GET /filings/

List Filings #

Access Level Required: Requires Standard Access (Level 1).


Retrieve a paginated list of regulatory filings.

L1 · Standard Access Idempotent
Parameters
added_to_platform_from string · date-time optional

Filter by date added to platform (inclusive start date, YYYY-MM-DDTHH:MM:SSZ format).

added_to_platform_to string · date-time optional

Filter by date added to platform (inclusive end date, YYYY-MM-DDTHH:MM:SSZ format).

categories string optional

Filter by multiple Filing Category IDs. Comma-separated (e.g., 1,3).

category integer optional

Filter by a single Filing Category ID.

company integer optional

Filter by internal Company ID.

company_isin string optional

Filter by Company ISIN. Case-insensitive.

countries string optional

Filter by Company country ISO Alpha-2 code(s). Comma-separated for multiple values (e.g., US,GB,DE).

extensions string optional

Filter by file extension(s). Single (e.g., PDF) or comma-separated (e.g., PDF,XBRL). Case-insensitive.

file_size_max integer optional

Filter by maximum file size in bytes.

file_size_min integer optional

Filter by minimum file size in bytes.

fiscal_period string optional

Filter by fiscal period. Possible values: FY (Full Year), Q1, Q2, Q3, Q4, H1 (First Half), H2 (Second Half). Only populated for filing types: 10-K, 10-K-ESEF, IR, ER.

9MFYH1H2Q1Q2Q3Q4
fiscal_year integer optional

Filter by fiscal year (e.g., 2024). Only populated for filing types: 10-K, 10-K-ESEF, IR, ER.

language string optional

Filter by a single filing language ISO 639-1 code (e.g., en).

languages string optional

Filter by filing language ISO 639-1 code(s). Comma-separated for multiple values (e.g., en,de).

lei string optional

Filter by Company Legal Entity Identifier (LEI).

on_watchlist boolean optional

Filter by companies on the user's watchlist. Use 'true' to see only watchlist companies, 'false' to exclude them. Omitting the parameter returns all companies.

ordering string optional

Which field to use when ordering the results. Available fields: id, release_datetime, added_to_platform. Prefix with '-' for descending order (e.g., -release_datetime).

page integer optional

A page number within the paginated result set.

page_size integer optional

Number of results to return per page.

period_ending_date string optional

Filter by the exact period ending date (YYYY-MM-DD, e.g., 2024-12-31). Only populated for filing types: 10-K, 10-K-ESEF, IR, ER.

period_ending_date_from string optional

Filter by period ending date — inclusive start (YYYY-MM-DD).

period_ending_date_to string optional

Filter by period ending date — inclusive end (YYYY-MM-DD).

release_datetime_from string · date-time optional

Filter by release datetime (inclusive start, YYYY-MM-DDTHH:MM:SSZ format).

release_datetime_to string · date-time optional

Filter by release datetime (inclusive end, YYYY-MM-DDTHH:MM:SSZ format).

search string optional

Search across filing title and associated company name. Case-insensitive. Multiple whitespace-separated terms are AND-combined (each term must match either the title or the company name).

source number optional

Filter by a single data source ID.

sources string optional

Filter by data source ID(s). Comma-separated for multiple values (e.g., 38,40,51).

type string optional

Filter by Filing Type code (e.g., 10-K).

types string optional

Filter by multiple Filing Type codes. Comma-separated (e.g., 10-K,10-Q).

updated_date_from string · date-time optional

Filter by the date a filing was last updated on the platform (inclusive start, YYYY-MM-DDTHH:MM:SSZ format).

updated_date_to string · date-time optional

Filter by the date a filing was last updated on the platform (inclusive end, YYYY-MM-DDTHH:MM:SSZ format).

view string optional · default summary

Controls the level of detail. Omit for a default 'summary' view, or use 'full' to include all details for each filing.

fullsummary
Responses
200 OK
401 Unauthenticated
Log in to try this endpoint live with your API key.
GET /filings/{id}/

Retrieve Filing Details #

Access Level Required: Requires Standard Access (Level 1).


Retrieve detailed information for a single filing by its ID.

L1 · Standard Access Idempotent
Parameters
id integer required · path

A unique integer value identifying this filing.

Responses
200 OK
401 Unauthenticated
404 Not Found
Log in to try this endpoint live with your API key.
GET /filings/{id}/history/

Retrieve Filing History (Audit Trail) #

Access Level Required: Requires Standard Access (Level 1).


Retrieve a point-in-time audit trail of material changes made to this filing (e.g., classification or status updates).

L1 · Standard Access Idempotent
Parameters
id integer required · path

A unique integer value identifying this filing.

Responses
200 OK
404 Not Found
Log in to try this endpoint live with your API key.
GET /filings/{id}/markdown/

Retrieve Filing Markdown #

Access Level Required: Requires Processed Filings (Level 2) access to view full converted content.


Retrieve the raw processed content of a single filing in Markdown format.

L2 · Processed Filings Idempotent
Parameters
id integer required · path

A unique integer value identifying this filing.

Responses
200 OK
403 Forbidden — tier or quota
404 Not Found
Log in to try this endpoint live with your API key.

Companies

Endpoints for querying company profiles and identifiers.

GET /companies/

List Companies #

Access Level Required: Requires Standard Access (Level 1).


Retrieve a paginated list of companies.

L1 · Standard Access Idempotent
Parameters
countries string optional

Filter by Company country ISO Alpha-2 code(s). Comma-separated for multiple values.

industry string optional

Filter by ISIC Group code.

industry_group string optional

Filter by ISIC Division code.

isin string optional

Filter by Company ISIN. Case-insensitive.

lei string optional

Filter by Company Legal Entity Identifier (LEI). Case-insensitive.

on_watchlist boolean optional

Filter by companies on the user's watchlist. Use 'true' to see only watchlist companies, 'false' to exclude them. Omitting the parameter returns all companies.

ordering string optional

Which field to use when ordering the results. Available fields: id, name, date_ipo, year_founded, country_iso__name. Prefix with '-' for descending order (e.g., -name).

page integer optional

A page number within the paginated result set.

page_size integer optional

Number of results to return per page.

search string optional

Search across company name, LEI, ticker symbol, and associated ISIN codes. Case-insensitive. Multiple whitespace-separated terms are AND-combined (each term must match at least one of the searched fields).

sector string optional

Filter by ISIC Section code.

sub_industry string optional

Filter by ISIC Class code.

ticker string optional

Filter by Company primary stock Ticker symbol. Case-insensitive.

view string optional · default summary

Controls the level of detail. Omit for a default 'summary' view, or use 'full' to include all details for each company.

fullsummary
Responses
200 OK
401 Unauthenticated
Log in to try this endpoint live with your API key.
GET /companies/{id}/

Retrieve Company Details #

Access Level Required: Requires Standard Access (Level 1).


Retrieve detailed information for a single company by its internal ID.

L1 · Standard Access Idempotent
Parameters
id integer required · path

A unique integer value identifying this company.

Responses
200 OK
401 Unauthenticated
404 Not Found
Log in to try this endpoint live with your API key.
GET /companies/{id}/financials/

Retrieve Company Financials #

Experimental endpoint — the response schema may change without an API version bump.

Returns standardized financial KPIs for a company as a structured document: a company envelope containing periods, each holding its Income Statement, Balance Sheet and Cash Flow statements, each holding line_items.

When several filings report the same period, the most recently published filing is selected; every contributing filing is listed in the statement's sources array. source_filing and sources are returned only for accounts with source unmasking enabled (sources_masked reports which applies). Use as_of=YYYY-MM-DD for a point-in-time view.

Use the depth and parent_code fields on each line item to render the Capital IQ-style statement hierarchy.

Access Level Required: Requires RAG / Agent (Level 3).

L3 · Financial KPIs Idempotent
Parameters
id integer required · path

A unique integer value identifying this company.

as_of string optional

Point-in-time query (YYYY-MM-DD). Returns the financials as they were known on that date — only filings released on or before as_of are considered when picking the statement for each period.

fiscal_period string optional

Filter by fiscal period.

9MFYH1H2Q1Q2Q3Q4
fiscal_year integer optional

Filter by exact fiscal year (e.g. 2024).

fiscal_year_from integer optional

Fiscal year range start (inclusive).

fiscal_year_to integer optional

Fiscal year range end (inclusive).

line_items string optional

Comma-separated KPI codes to include (e.g. revenue,ebitda,net_income_loss). Omit to return all extracted line items. Statements with none of the requested codes are dropped. Unknown codes return 400 — see /api/line-item-definitions/.

statement_type string optional

Filter to a single statement type.

BSCFSIS
Responses
200 OK
400 Bad Request
404 Not Found
Log in to try this endpoint live with your API key.
GET /companies/{id}/next-annual-report/

Predict Next Annual Report #

Calculates the expected release window for the next annual report based on historical filing patterns.

L1 · Standard Access Idempotent
Parameters
id integer required · path

A unique integer value identifying this company.

Responses
200 OK
404 Not Found
Log in to try this endpoint live with your API key.

ISINs

Endpoints for resolving ISINs to Companies.

GET /isins/

List ISINs #

Access Level Required: Requires Standard Access (Level 1).


Search and resolve ISINs (International Securities Identification Numbers) to companies.

L1 · Standard Access Idempotent
Parameters
code string optional

codes string optional

Filter by multiple ISIN codes. Comma-separated (e.g., US1234567890,DE1234567890).

company integer optional

Filter by internal Company ID.

is_primary boolean optional

page integer optional

A page number within the paginated result set.

page_size integer optional

Number of results to return per page.

search string optional

Fuzzy search by ISIN code (e.g., 'US03').

Responses
200 OK
Log in to try this endpoint live with your API key.
GET /isins/{code}/

Retrieve ISIN #

Access Level Required: Requires Standard Access (Level 1).


Retrieve details for a specific ISIN.

L1 · Standard Access Idempotent
Parameters
code string required · path

Responses
200 OK
Log in to try this endpoint live with your API key.

Watchlist

Endpoints for managing your personal company watchlist.

GET /watchlist/

Get User's Watchlist #

Access Level Required: Requires Standard Access (Level 1).


Fetches all companies currently in the authenticated user's watchlist. Results are paginated.

L1 · Standard Access Idempotent
Responses
200 OK
401 Unauthenticated
Log in to try this endpoint live with your API key.
POST /watchlist/companies/

Add Company to Watchlist #

Access Level Required: Requires Standard Access (Level 1).


Adds a specified company to the authenticated user's watchlist.

L1 · Standard Access
Request body
company_id integer required

The unique identifier of the company to add or remove from the watchlist.

Example body
{
  "company_id": 14
}
Responses
201 Created
400 Bad Request
401 Unauthenticated
403 Forbidden — tier or quota
Log in to try this endpoint live with your API key.
DELETE /watchlist/companies/{company_id}/

Remove Company from Watchlist #

Access Level Required: Requires Standard Access (Level 1).


Removes a specified company from the authenticated user's watchlist using the company_id from the URL path.

L1 · Standard Access
Parameters
company_id integer required · path

Responses
200 OK
401 Unauthenticated
403 Forbidden — tier or quota
404 Not Found
Log in to try this endpoint live with your API key.
POST /watchlist/companies/bulk-add/

Bulk Add Companies to Watchlist #

Access Level Required: Requires Standard Access (Level 1).


Adds up to 100 companies to the authenticated user's watchlist in a single request. Companies already in the watchlist are silently skipped.

L1 · Standard Access
Request body
company_ids array<integer> required

A list of company IDs (1–100) to add or remove from the watchlist.

Example body
{
  "company_ids": [
    14,
    27,
    42
  ]
}
Responses
200 OK
400 Bad Request
401 Unauthenticated
403 Forbidden — tier or quota
Log in to try this endpoint live with your API key.
POST /watchlist/companies/bulk-remove/

Bulk Remove Companies from Watchlist #

Access Level Required: Requires Standard Access (Level 1).


Removes up to 100 companies from the authenticated user's watchlist in a single request. Companies not in the watchlist are silently skipped.

L1 · Standard Access
Request body
company_ids array<integer> required

A list of company IDs (1–100) to add or remove from the watchlist.

Example body
{
  "company_ids": [
    14,
    27
  ]
}
Responses
200 OK
400 Bad Request
401 Unauthenticated
403 Forbidden — tier or quota
Log in to try this endpoint live with your API key.

ISIC Classifications

Endpoints for Browse the ISIC industrial classification system.

GET /isic-classes/

List ISIC Classes #

Access Level Required: Requires Standard Access (Level 1).


Retrieve a paginated list of ISIC Classes.

L1 · Standard Access Idempotent
Parameters
code string optional

code__iexact string optional

code__in array<string> optional

Multiple values may be separated by commas.

industry_code string optional

Filter by parent ISIC Group code (e.g., 011)

industry_group_code string optional

Filter by grandparent ISIC Division code (e.g., 01)

name__icontains string optional

page integer optional

A page number within the paginated result set.

page_size integer optional

Number of results to return per page.

sector_code string optional

Filter by great-grandparent ISIC Section code (e.g., A)

Responses
200 OK
Log in to try this endpoint live with your API key.
GET /isic-classes/{id}/

Retrieve ISIC Class #

Access Level Required: Requires Standard Access (Level 1).


Retrieve details for a specific ISIC Class by its ID.

L1 · Standard Access Idempotent
Parameters
id integer required · path

A unique integer value identifying this sub industry.

Responses
200 OK
Log in to try this endpoint live with your API key.
GET /isic-divisions/

List ISIC Divisions #

Access Level Required: Requires Standard Access (Level 1).


Retrieve a paginated list of ISIC Divisions.

L1 · Standard Access Idempotent
Parameters
code string optional

code__iexact string optional

code__in array<string> optional

Multiple values may be separated by commas.

name__icontains string optional

page integer optional

A page number within the paginated result set.

page_size integer optional

Number of results to return per page.

sector_code string optional

Filter by parent ISIC Section code (e.g., A)

Responses
200 OK
Log in to try this endpoint live with your API key.
GET /isic-divisions/{id}/

Retrieve ISIC Division #

Access Level Required: Requires Standard Access (Level 1).


Retrieve details for a specific ISIC Division by its ID.

L1 · Standard Access Idempotent
Parameters
id integer required · path

A unique integer value identifying this industry group.

Responses
200 OK
Log in to try this endpoint live with your API key.
GET /isic-groups/

List ISIC Groups #

Access Level Required: Requires Standard Access (Level 1).


Retrieve a paginated list of ISIC Groups.

L1 · Standard Access Idempotent
Parameters
code string optional

code__iexact string optional

code__in array<string> optional

Multiple values may be separated by commas.

industry_group_code string optional

Filter by parent ISIC Division code (e.g., 01)

name__icontains string optional

page integer optional

A page number within the paginated result set.

page_size integer optional

Number of results to return per page.

sector_code string optional

Filter by grandparent ISIC Section code (e.g., A)

Responses
200 OK
Log in to try this endpoint live with your API key.
GET /isic-groups/{id}/

Retrieve ISIC Group #

Access Level Required: Requires Standard Access (Level 1).


Retrieve details for a specific ISIC Group by its ID.

L1 · Standard Access Idempotent
Parameters
id integer required · path

A unique integer value identifying this industry.

Responses
200 OK
Log in to try this endpoint live with your API key.
GET /isic-sections/

List ISIC Sections #

Access Level Required: Requires Standard Access (Level 1).


Retrieve a paginated list of ISIC Sections.

L1 · Standard Access Idempotent
Parameters
code string optional

code__iexact string optional

code__in array<string> optional

Multiple values may be separated by commas.

name__icontains string optional

page integer optional

A page number within the paginated result set.

page_size integer optional

Number of results to return per page.

Responses
200 OK
Log in to try this endpoint live with your API key.
GET /isic-sections/{id}/

Retrieve ISIC Section #

Access Level Required: Requires Standard Access (Level 1).


Retrieve details for a specific ISIC Section by its ID.

L1 · Standard Access Idempotent
Parameters
id integer required · path

A unique integer value identifying this sector.

Responses
200 OK
Log in to try this endpoint live with your API key.

Filing Categories

Reference data for the 11 standardized disclosure types (FRCF).

GET /filing-categories/

List Filing Categories #

Access Level Required: Requires Standard Access (Level 1).


Retrieve the 11 standardized disclosure types (categories) defined by the FRCF.

L1 · Standard Access Idempotent
Parameters
page integer optional

A page number within the paginated result set.

page_size integer optional

Number of results to return per page.

Responses
200 OK
Log in to try this endpoint live with your API key.
GET /filing-categories/{id}/

Retrieve Filing Category #

Access Level Required: Requires Standard Access (Level 1).


Retrieve details for a specific filing category by its ID.

L1 · Standard Access Idempotent
Parameters
id integer required · path

A unique integer value identifying this filing category.

Responses
200 OK
Log in to try this endpoint live with your API key.

Filing Types

Reference data for all supported types of filings.

GET /filing-types/

List Filing Types #

Access Level Required: Requires Standard Access (Level 1).


Retrieve a paginated list of all available filing types.

L1 · Standard Access Idempotent
Parameters
category integer optional

page integer optional

A page number within the paginated result set.

page_size integer optional

Number of results to return per page.

search string optional

A search term.

Responses
200 OK
Log in to try this endpoint live with your API key.
GET /filing-types/{id}/

Retrieve Filing Type #

Access Level Required: Requires Standard Access (Level 1).


Retrieve details for a specific filing type by its ID.

L1 · Standard Access Idempotent
Parameters
id integer required · path

A unique integer value identifying this filing type.

Responses
200 OK
Log in to try this endpoint live with your API key.

Sources

Reference data for the original sources of filings.

GET /sources/

List Data Sources #

Access Level Required: Requires Standard Access (Level 1).


Retrieve a paginated list of all available data sources.

L1 · Standard Access Idempotent
Parameters
page integer optional

A page number within the paginated result set.

page_size integer optional

Number of results to return per page.

Responses
200 OK
Log in to try this endpoint live with your API key.
GET /sources/{id}/

Retrieve Data Source #

Access Level Required: Requires Standard Access (Level 1).


Retrieve details for a specific data source by its ID.

L1 · Standard Access Idempotent
Parameters
id integer required · path

A unique integer value identifying this source.

Responses
200 OK
Log in to try this endpoint live with your API key.

Countries

Reference data for all supported countries.

GET /countries/

List Countries #

Access Level Required: Requires Standard Access (Level 1).


Retrieve a list of all supported countries.

L1 · Standard Access Idempotent
Parameters
page integer optional

A page number within the paginated result set.

page_size integer optional

Number of results to return per page.

Responses
200 OK
Log in to try this endpoint live with your API key.
GET /countries/{id}/

Retrieve Country #

Access Level Required: Requires Standard Access (Level 1).


Retrieve details for a specific country by its ID.

L1 · Standard Access Idempotent
Parameters
id integer required · path

A unique integer value identifying this country.

Responses
200 OK
Log in to try this endpoint live with your API key.

Languages

Reference data for all supported languages.

GET /languages/

List Languages #

Access Level Required: Requires Standard Access (Level 1).


Retrieve a list of all supported languages for filings.

L1 · Standard Access Idempotent
Parameters
page integer optional

A page number within the paginated result set.

page_size integer optional

Number of results to return per page.

Responses
200 OK
Log in to try this endpoint live with your API key.
GET /languages/{id}/

Retrieve Language #

Access Level Required: Requires Standard Access (Level 1).


Retrieve details for a specific language by its ID.

L1 · Standard Access Idempotent
Parameters
id integer required · path

A unique integer value identifying this Language.

Responses
200 OK
Log in to try this endpoint live with your API key.

Webhooks (Management)

Endpoints for creating, viewing, and managing your webhook subscriptions.

GET /webhooks/

List Webhooks #

Retrieve a list of all webhooks configured for your account. Note: Secret keys are not returned in this list.

L1 · Standard Access Idempotent
Parameters
page integer optional

A page number within the paginated result set.

page_size integer optional

Number of results to return per page.

Responses
200 OK
Log in to try this endpoint live with your API key.
POST /webhooks/

Create Webhook #

Create a new webhook subscription. The secret_key is returned in the response only once.

L1 · Standard Access
Request body
created_at string · date-time required

Timestamp when the webhook was created.

id integer required

The unique identifier for the webhook.

updated_at string · date-time required

Timestamp when the webhook was last updated.

url string · uri required

The endpoint URL (HTTPS required) to which the webhook payloads will be sent.

include_isins boolean optional

Set to 'true' to include the list of ISINs in the company object. Warning: Large companies may have thousands of ISINs, increasing payload size.

include_markdown boolean optional

Set to 'true' to include the full 'markdown_content' in the webhook payload. Set to 'false' to receive a payload without the markdown body.

is_active boolean optional

Set to 'false' to temporarily disable this webhook without deleting it.

subscribed_filing_types array<string> optional

A list of filing type codes (e.g., ['10-K', 'Annual Report']) to subscribe to. If this list is empty or omitted, you will be subscribed to all filing types.

track_all_companies boolean optional

Set to 'true' to subscribe to the Global Firehose. You will receive notifications for filings from ALL companies in the database, regardless of your Watchlist.

trigger_on_filing_processed boolean optional

If true, triggers when the filing has been fully analyzed and converted (Complete). Includes verified metadata and markdown content.

trigger_on_filing_received boolean optional

If true, triggers immediately when a filing is detected (Fastest). Note: Metadata like filing type may be null, and no markdown is included.

Example body
{
  "url": "https://api.your-domain.com/webhook-receiver",
  "is_active": true,
  "include_markdown": false,
  "include_isins": false,
  "trigger_on_filing_received": false,
  "trigger_on_filing_processed": true,
  "track_all_companies": false,
  "subscribed_filing_types": [
    "10-K",
    "Annual Report"
  ]
}
Responses
201 Created
Log in to try this endpoint live with your API key.
GET /webhooks/{id}/

Retrieve Webhook #

Retrieve the details of a specific webhook by its ID. Note: Secret keys are not visible here.

L1 · Standard Access Idempotent
Parameters
id integer required · path

A unique integer value identifying this webhook.

Responses
200 OK
Log in to try this endpoint live with your API key.
PUT /webhooks/{id}/

Update Webhook #

Update the details of a specific webhook.

L1 · Standard Access
Parameters
id integer required · path

A unique integer value identifying this webhook.

Request body
created_at string · date-time required

Timestamp when the webhook was created.

id integer required

The unique identifier for the webhook.

updated_at string · date-time required

Timestamp when the webhook was last updated.

url string · uri required

The endpoint URL (HTTPS required) to which the webhook payloads will be sent.

include_isins boolean optional

Set to 'true' to include the list of ISINs in the company object. Warning: Large companies may have thousands of ISINs, increasing payload size.

include_markdown boolean optional

Set to 'true' to include the full 'markdown_content' in the webhook payload. Set to 'false' to receive a payload without the markdown body.

is_active boolean optional

Set to 'false' to temporarily disable this webhook without deleting it.

subscribed_filing_types array<string> optional

A list of filing type codes (e.g., ['10-K', 'Annual Report']) to subscribe to. If this list is empty or omitted, you will be subscribed to all filing types.

track_all_companies boolean optional

Set to 'true' to subscribe to the Global Firehose. You will receive notifications for filings from ALL companies in the database, regardless of your Watchlist.

trigger_on_filing_processed boolean optional

If true, triggers when the filing has been fully analyzed and converted (Complete). Includes verified metadata and markdown content.

trigger_on_filing_received boolean optional

If true, triggers immediately when a filing is detected (Fastest). Note: Metadata like filing type may be null, and no markdown is included.

Example body
{
  "url": "https://api.your-domain.com/webhook-receiver",
  "is_active": true,
  "include_markdown": false,
  "include_isins": false,
  "trigger_on_filing_received": false,
  "trigger_on_filing_processed": true,
  "track_all_companies": false,
  "subscribed_filing_types": [
    "10-K",
    "Annual Report"
  ]
}
Responses
200 OK
Log in to try this endpoint live with your API key.
PATCH /webhooks/{id}/

Partial Update Webhook #

Partially update the details of a specific webhook.

L1 · Standard Access
Parameters
id integer required · path

A unique integer value identifying this webhook.

Request body
created_at string · date-time optional

Timestamp when the webhook was created.

id integer optional

The unique identifier for the webhook.

include_isins boolean optional

Set to 'true' to include the list of ISINs in the company object. Warning: Large companies may have thousands of ISINs, increasing payload size.

include_markdown boolean optional

Set to 'true' to include the full 'markdown_content' in the webhook payload. Set to 'false' to receive a payload without the markdown body.

is_active boolean optional

Set to 'false' to temporarily disable this webhook without deleting it.

subscribed_filing_types array<string> optional

A list of filing type codes (e.g., ['10-K', 'Annual Report']) to subscribe to. If this list is empty or omitted, you will be subscribed to all filing types.

track_all_companies boolean optional

Set to 'true' to subscribe to the Global Firehose. You will receive notifications for filings from ALL companies in the database, regardless of your Watchlist.

trigger_on_filing_processed boolean optional

If true, triggers when the filing has been fully analyzed and converted (Complete). Includes verified metadata and markdown content.

trigger_on_filing_received boolean optional

If true, triggers immediately when a filing is detected (Fastest). Note: Metadata like filing type may be null, and no markdown is included.

updated_at string · date-time optional

Timestamp when the webhook was last updated.

url string · uri optional

The endpoint URL (HTTPS required) to which the webhook payloads will be sent.

Example body
{
  "is_active": false
}
Responses
200 OK
Log in to try this endpoint live with your API key.
DELETE /webhooks/{id}/

Delete Webhook #

Permanently delete a webhook subscription by its ID.

L1 · Standard Access
Parameters
id integer required · path

A unique integer value identifying this webhook.

Responses
204 No Content
Log in to try this endpoint live with your API key.
GET /webhooks/{id}/deliveries/

List Delivery Logs #

Retrieve a paginated list of delivery attempts (logs) for a specific webhook.

L1 · Standard Access Idempotent
Parameters
id integer required · path

A unique integer value identifying this webhook.

Responses
200 OK
Log in to try this endpoint live with your API key.
GET /webhooks/{id}/deliveries/{delivery_uuid}/

Retrieve Delivery Detail #

Retrieve full details for a single delivery, including the reconstructed request payload and headers. The payload is rebuilt dynamically from the referenced filing record.

L1 · Standard Access Idempotent
Parameters
delivery_uuid string required · path

id integer required · path

A unique integer value identifying this webhook.

Responses
200 OK
404 Not Found
Log in to try this endpoint live with your API key.
POST /webhooks/{id}/deliveries/{delivery_uuid}/replay/

Replay Delivery #

Re-sends the webhook event for a specific delivery. A new delivery record is created with the result of the replay attempt.

L1 · Standard Access
Parameters
delivery_uuid string required · path

id integer required · path

A unique integer value identifying this webhook.

Request body
created_at string · date-time required

Timestamp when the webhook was created.

id integer required

The unique identifier for the webhook.

updated_at string · date-time required

Timestamp when the webhook was last updated.

url string · uri required

The endpoint URL (HTTPS required) to which the webhook payloads will be sent.

include_isins boolean optional

Set to 'true' to include the list of ISINs in the company object. Warning: Large companies may have thousands of ISINs, increasing payload size.

include_markdown boolean optional

Set to 'true' to include the full 'markdown_content' in the webhook payload. Set to 'false' to receive a payload without the markdown body.

is_active boolean optional

Set to 'false' to temporarily disable this webhook without deleting it.

subscribed_filing_types array<string> optional

A list of filing type codes (e.g., ['10-K', 'Annual Report']) to subscribe to. If this list is empty or omitted, you will be subscribed to all filing types.

track_all_companies boolean optional

Set to 'true' to subscribe to the Global Firehose. You will receive notifications for filings from ALL companies in the database, regardless of your Watchlist.

trigger_on_filing_processed boolean optional

If true, triggers when the filing has been fully analyzed and converted (Complete). Includes verified metadata and markdown content.

trigger_on_filing_received boolean optional

If true, triggers immediately when a filing is detected (Fastest). Note: Metadata like filing type may be null, and no markdown is included.

Responses
202 202
404 Not Found
Log in to try this endpoint live with your API key.
POST /webhooks/{id}/regenerate-secret/

Regenerate Secret Key #

Generates a new, unique secret_key for this webhook. The old key will be invalidated immediately. This action is irreversible.

L1 · Standard Access
Parameters
id integer required · path

A unique integer value identifying this webhook.

Request body
created_at string · date-time required

Timestamp when the webhook was created.

id integer required

The unique identifier for the webhook.

updated_at string · date-time required

Timestamp when the webhook was last updated.

url string · uri required

The endpoint URL (HTTPS required) to which the webhook payloads will be sent.

include_isins boolean optional

Set to 'true' to include the list of ISINs in the company object. Warning: Large companies may have thousands of ISINs, increasing payload size.

include_markdown boolean optional

Set to 'true' to include the full 'markdown_content' in the webhook payload. Set to 'false' to receive a payload without the markdown body.

is_active boolean optional

Set to 'false' to temporarily disable this webhook without deleting it.

subscribed_filing_types array<string> optional

A list of filing type codes (e.g., ['10-K', 'Annual Report']) to subscribe to. If this list is empty or omitted, you will be subscribed to all filing types.

track_all_companies boolean optional

Set to 'true' to subscribe to the Global Firehose. You will receive notifications for filings from ALL companies in the database, regardless of your Watchlist.

trigger_on_filing_processed boolean optional

If true, triggers when the filing has been fully analyzed and converted (Complete). Includes verified metadata and markdown content.

trigger_on_filing_received boolean optional

If true, triggers immediately when a filing is detected (Fastest). Note: Metadata like filing type may be null, and no markdown is included.

Responses
200 OK
Log in to try this endpoint live with your API key.
POST /webhooks/{id}/test/

Test Webhook #

Sends a pre-defined 'filing.processed.test' event to the configured webhook URL to verify its functionality. This creates a delivery record.

L1 · Standard Access
Parameters
id integer required · path

A unique integer value identifying this webhook.

Request body
created_at string · date-time required

Timestamp when the webhook was created.

id integer required

The unique identifier for the webhook.

updated_at string · date-time required

Timestamp when the webhook was last updated.

url string · uri required

The endpoint URL (HTTPS required) to which the webhook payloads will be sent.

include_isins boolean optional

Set to 'true' to include the list of ISINs in the company object. Warning: Large companies may have thousands of ISINs, increasing payload size.

include_markdown boolean optional

Set to 'true' to include the full 'markdown_content' in the webhook payload. Set to 'false' to receive a payload without the markdown body.

is_active boolean optional

Set to 'false' to temporarily disable this webhook without deleting it.

subscribed_filing_types array<string> optional

A list of filing type codes (e.g., ['10-K', 'Annual Report']) to subscribe to. If this list is empty or omitted, you will be subscribed to all filing types.

track_all_companies boolean optional

Set to 'true' to subscribe to the Global Firehose. You will receive notifications for filings from ALL companies in the database, regardless of your Watchlist.

trigger_on_filing_processed boolean optional

If true, triggers when the filing has been fully analyzed and converted (Complete). Includes verified metadata and markdown content.

trigger_on_filing_received boolean optional

If true, triggers immediately when a filing is detected (Fastest). Note: Metadata like filing type may be null, and no markdown is included.

Responses
200 OK
400 Bad Request
Log in to try this endpoint live with your API key.

Financial Data

Endpoints for standardized financial KPIs (Income Statement, Balance Sheet, Cash Flow Statement) and the line item definition dictionary.

GET /line-item-definitions/

List Line Item Definitions #

Retrieve the full dictionary of standardized financial KPIs.

Each definition describes one line item that may appear in extracted financial statements (Income Statement, Balance Sheet, Cash Flow Statement). Use the depth and parent_code fields to reconstruct the Capital IQ-style hierarchy.

Access Level Required: Requires Standard Access (Level 1).

L1 · Standard Access Idempotent
Parameters
depth integer optional

Filter by hierarchy depth (0 = top-level, 1 = component, 2 = sub-component).

is_capital_iq_standard boolean optional

page integer optional

A page number within the paginated result set.

page_size integer optional

Number of results to return per page.

parent_code string optional

Filter by parent line item code (e.g. 'gross_profit' returns its children).

search string optional

A search term.

statement_type string optional

Filter by statement type (IS, BS, CFS, SUP).

  • IS - Income Statement
  • BS - Balance Sheet
  • CFS - Cash Flow Statement
  • SUP - Supplemental / Ratio
BSCFSISSUP
Responses
200 OK
Log in to try this endpoint live with your API key.
GET /line-item-definitions/{code}/

Retrieve Line Item Definition #

Retrieve a single line item definition by its code.

Access Level Required: Requires Standard Access (Level 1).

L1 · Standard Access Idempotent
Parameters
code string required · path

Responses
200 OK
Log in to try this endpoint live with your API key.