Filing - Docs

The data dictionary and definitions for a Filing

Fields

Parameter	Type	Description
filing_id	int	The Aiera-unique identifier for the filing
equity *	obj	The associated equity object (see below)
title	str	The title of the filing document
form_number	str	The official SEC-assigned form number (e.g., 10-K, 10-Q, 8-K)
form_name	str	The human-readable short form name (e.g., "Quarterly Report")
filing_organization	str	The entity responsible for publishing the filing (e.g., sec)
filing_system	str	The filing system used (e.g., edgar)
is_amendment	bool	Whether this filing document is an amendment
period_end_date	date	The ISO-formatted end date of the reporting period covered by the filing
release_date	datetime	The ISO-formatted date and time of when the filing was publicly released
arrival_date	datetime	The ISO-formatted date and time of when the filing was received and accepted by the filing organization
pulled_date	datetime	The ISO-formatted date and time of when the filing was retrieved by Aiera
pdf_url	str	URL of the filing document in PDF format
aiera_url	str	URL to the filing document in the Aiera dashboard
json_synced	bool	Whether the filing data has been synced to JSON format
json_available	bool	Whether the filing JSON data is available for retrieval
datafiles_synced	bool	Whether associated data files have been synced (list endpoint only)
summary *	list	AI-generated summary paragraphs of the filing (single filing endpoint only)
datafiles *	list	Array of XBRL and other data files associated with the filing (single filing endpoint only)

equity

{
  "equity": {
    "equity_id": 1,
    "company_id": 1,
    "name": "Amazon.com Inc",
    "common_name": "Amazon",
    "local_ticker": "AMZN",
    "mic": "XNAS",
    "bloomberg_ticker": "AMZN:US",
    "isin": "US0231351067",
    "permid": "4307665276"
  }
}

Parameter	Type	Description
equity_id	int	The Aiera-unique identifier for the equity
company_id	int	The Aiera-unique identifier for the parent company
name	str	The official name of the equity
common_name	str	The common name of the equity
local_ticker	str	The ticker on the local exchange
mic	str	The Market Identifier Code for the exchange
bloomberg_ticker	str	The Bloomberg identifier for the equity
isin	str	The ISIN for the equity
permid	str	The PermID for the equity

Possibles

filing_organization

Option	Description
sec	U.S. Securities and Exchange Commission

filing_system

Option	Description
edgar	SEC EDGAR filing system

summary

The summary field contains an array of strings, where each string is a paragraph summarizing a key aspect of the filing.

{
  "summary": [
    "Amazon.com, Inc.'s SEC filing reveals key financial metrics for the period ending September 30, 2024...",
    "Operating expenses saw a rise, primarily due to cost of sales, fulfillment, and technology infrastructure spending...",
    "Amazon faced legal proceedings concerning patent infringements and regulatory scrutiny..."
  ]
}

datafiles

{
  "datafiles": [
    {
      "file_type": "EX-101.SCH",
      "description": "XBRL TAXONOMY EXTENSION SCHEMA DOCUMENT",
      "origin": "https://www.sec.gov/Archives/edgar/data/1018724/...",
      "url": "https://premium.aiera.com/api/filings-v1/7968743/datafile/..."
    }
  ]
}

datafile fields

Parameter	Type	Description
file_type	str	The type of data file
description	str	Human-readable description of the file
origin	str	Original source URL of the file
url	str	Aiera API URL to retrieve the file

file_type options

Option	Description
EX-101.SCH	XBRL Taxonomy Extension Schema Document
EX-101.CAL	XBRL Taxonomy Extension Calculation Linkbase
EX-101.DEF	XBRL Taxonomy Extension Definition Linkbase
EX-101.LAB	XBRL Taxonomy Extension Label Linkbase
EX-101.PRE	XBRL Taxonomy Extension Presentation Linkbase
XML	Extracted XBRL Instance Document