SEC EDGAR Fundamentals

{'type': 'object', 'required': ['ticker'], 'properties': {'ticker': {'type': 'string', 'pattern': '^[A-Za-z][A-Za-z0-9.-]{0,11}$', 'maxLength': 12, 'minLength': 1, 'description': 'Exchange ticker symbol of a single SEC filer, case-insensitive, such as AAPL, MSFT or KO.'}}, 'description': 'Identifies the one company whose reference profile should be returned.', 'additionalProperties': False}

{'type': 'object', 'required': ['tickers', 'metric', 'period'], 'properties': {'limit': {'type': 'integer', 'default': 4, 'maximum': 12, 'minimum': 1, 'description': 'How many aligned reporting periods to return per company, newest first. Accepts 1 to 12; defaults to 4 when omitted.'}, 'metric': {'type': 'string', 'pattern': '^[a-z][a-z0-9_]*$', 'maxLength': 64, 'minLength': 1, 'description': 'The single normalized metric key every company is compared on, as published by list_metrics — for instance revenue, net_income or assets. One metric per call.'}, 'period': {'enum': ['annual', 'quarterly'], 'type': 'string', 'default': 'annual', 'description': "Reporting frequency to return: 'annual' for fiscal-year figures drawn from 10-K filings, 'quarterly' for fiscal-quarter figures drawn from 10-Q filings."}, 'tickers': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[A-Za-z][A-Za-z0-9.-]{0,11}$', 'maxLength': 12, 'minLength': 1, 'description': 'One exchange ticker symbol, case-insensitive, such as AAPL, MSFT or KO.'}, 'maxItems': 8, 'minItems': 2, 'description': 'The companies to compare, as exchange ticker symbols. Between 2 and 8 distinct symbols; duplicates are folded together and a symbol that does not resolve is reported on its own row rather than failing the call.'}}, 'description': 'Selects the filers to line up, the single metric to compare them on, and how many aligned periods to return.', 'additionalProperties': False}

{'type': 'object', 'required': ['ticker'], 'properties': {'limit': {'type': 'integer', 'default': 20, 'maximum': 200, 'minimum': 1, 'description': 'How many observations to return, newest first. Accepts 1 to 200; defaults to 20 when omitted. A decade of annual history needs about 10.'}, 'metric': {'type': 'string', 'pattern': '^[a-z][a-z0-9_]*$', 'maxLength': 64, 'minLength': 1, 'description': 'Normalized metric key to fetch, exactly as published by list_metrics — for instance revenue, net_income, assets, equity or operating_cash_flow. Call list_metrics first if unsure; a key outside that vocabulary is rejected.'}, 'ticker': {'type': 'string', 'pattern': '^[A-Za-z][A-Za-z0-9.-]{0,11}$', 'maxLength': 12, 'minLength': 1, 'description': 'Exchange ticker symbol of a single SEC filer, case-insensitive, such as AAPL, MSFT or KO.'}, 'taxonomy': {'enum': ['us-gaap', 'dei'], 'type': 'string', 'default': 'us-gaap', 'description': "XBRL taxonomy the resolved tag is drawn from: 'us-gaap' for financial statement concepts, 'dei' for entity-level facts such as shares outstanding. Defaults to 'us-gaap'."}}, 'description': 'Selects one company and one metric, and how deep a history of that metric to read.', 'additionalProperties': False}

{'type': 'object', 'required': ['ticker', 'period'], 'properties': {'limit': {'type': 'integer', 'default': 5, 'maximum': 20, 'minimum': 1, 'description': 'How many fiscal periods to return, newest first. Accepts 1 to 20; defaults to 5 when omitted.'}, 'period': {'enum': ['annual', 'quarterly'], 'type': 'string', 'default': 'annual', 'description': "Reporting frequency to return: 'annual' for fiscal-year figures drawn from 10-K filings, 'quarterly' for fiscal-quarter figures drawn from 10-Q filings."}, 'ticker': {'type': 'string', 'pattern': '^[A-Za-z][A-Za-z0-9.-]{0,11}$', 'maxLength': 12, 'minLength': 1, 'description': 'Exchange ticker symbol of a single SEC filer, case-insensitive, such as AAPL, MSFT or KO.'}, 'metrics': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[a-z][a-z0-9_]*$', 'maxLength': 64, 'minLength': 1, 'description': 'One normalized metric key, such as revenue, operating_income or net_income.'}, 'maxItems': 16, 'minItems': 1, 'description': "Optional subset of normalized metric keys to return, as published by list_metrics. Omit to receive the server's standard statement set; narrow it when only a few figures matter."}}, 'description': 'Selects one company, the fiscal periodicity of the statements, and optionally a narrower metric set.', 'additionalProperties': False}

{'type': 'object', 'required': [], 'properties': {'name': {'type': 'string', 'maxLength': 200, 'minLength': 1, 'description': 'A filed name, or the beginning of one, to look up candidate owner CIKs. Returns candidates with their most recent filing so one can be chosen; it never picks a person and never merges two CIKs that share a spelling.'}, 'owner_cik': {'type': 'string', 'pattern': '^\\d{1,10}$', 'maxLength': 10, 'minLength': 1, 'description': "The insider's Central Index Key, zero-padded or not — '0001214156' and '1214156' are the same person. This is the identity key throughout: the SEC assigns it and it is stable, whereas a name is neither unique nor stable. Every row returned by the other insider tools carries the owner CIK to pass here."}, 'window_days': {'type': 'integer', 'default': 365, 'maximum': 3650, 'minimum': 1, 'description': 'Trailing window in days, ending today, over which the liquidity signals and the windowed proceeds total are computed. Accepts 1 to 3650; defaults to 365. The lifetime ledger is returned regardless of this value.'}}, 'description': "Identifies one insider. Supply exactly one of owner_cik, which returns that person's profile, or name, which returns candidate CIKs to choose between — supplying both, or neither, is rejected before anything is read.", 'additionalProperties': False}

{'type': 'object', 'required': ['ticker'], 'properties': {'code': {'type': 'string', 'pattern': '^[A-Za-z]{1,2}$', 'maxLength': 2, 'minLength': 1, 'description': 'One Form 3/4/5 transaction code to match, such as P for an open-market purchase, S for an open-market sale, A for a grant, M for an option exercise or F for shares withheld against an exercise obligation or a tax liability. list_ownership_codes publishes the whole vocabulary free. Omit to match every code.'}, 'limit': {'type': 'integer', 'default': 50, 'maximum': 100, 'minimum': 1, 'description': 'Transaction rows per page, newest first. Accepts 1 to 100; defaults to 50 when omitted. The ceiling cannot be raised by a parameter and is published in the response.'}, 'offset': {'type': 'integer', 'default': 0, 'maximum': 5000, 'minimum': 0, 'description': 'Rows to skip before this page, for paging through a result set. Accepts 0 to 5000; defaults to 0. Narrow the filters rather than paging deeper.'}, 'ticker': {'type': 'string', 'pattern': '^[A-Za-z][A-Za-z0-9.-]{0,11}$', 'maxLength': 12, 'minLength': 1, 'description': 'Exchange ticker symbol of a single SEC filer, case-insensitive, such as AAPL, MSFT or KO.'}, 'end_date': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'maxLength': 10, 'minLength': 10, 'description': 'Latest transaction date to include, inclusive, as YYYY-MM-DD. Leave it out for an open-ended range running to the newest row in the corpus.'}, 'row_kind': {'enum': ['transaction', 'holding'], 'type': 'string', 'description': "Restrict to 'transaction' rows, which report an event, or 'holding' rows, which report a position — a Form 3 reports holdings, and counting one as activity would read as a purchase on the day somebody joined. Omit to receive both."}, 'direction': {'enum': ['A', 'D'], 'type': 'string', 'description': "Restrict to acquisitions ('A') or disposals ('D'), read from the filing's own acquired/disposed flag and never derived from the transaction code. A code and a direction disagree routinely: an option exercise disposes of the derivative security while acquiring common stock. Omit to match both."}, 'start_date': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'maxLength': 10, 'minLength': 10, 'description': 'Earliest transaction date to include, inclusive, as YYYY-MM-DD. Matched against the date the transaction happened, not the date the filing arrived — the two differ by days on a Form 4 and by up to a year on a Form 5.'}}, 'description': 'Selects one company by ticker, and optionally narrows to a date range, a transaction code, a direction or a row kind before the rows are read.', 'additionalProperties': False}

{'type': 'object', 'required': [], 'properties': {}, 'description': 'Takes no arguments: the sample is deliberately unfiltered and identical for every caller.', 'additionalProperties': False}

{'type': 'object', 'required': ['ticker'], 'properties': {'form': {'type': 'string', 'description': 'Optional EDGAR form-type filter, for example "10-K" for annual reports, "10-Q" for quarterly, or "8-K" for material events. Omit to receive every form type. Narrowing here is cheaper than filtering the returned rows.'}, 'limit': {'type': 'integer', 'default': 25, 'maximum': 100, 'minimum': 1, 'description': 'How many filings to return, newest first. Accepts 1 to 100; defaults to 25 when omitted. Ask for the fewest that answer the question.'}, 'ticker': {'type': 'string', 'pattern': '^[A-Za-z][A-Za-z0-9.-]{0,11}$', 'maxLength': 12, 'minLength': 1, 'description': 'Exchange ticker symbol of a single SEC filer, case-insensitive, such as AAPL, MSFT or KO.'}}, 'description': 'Selects one company, optionally one form type, and how far back through its filing history to read.', 'additionalProperties': False}

{'type': 'object', 'required': [], 'properties': {}, 'description': 'Takes no arguments: the metric vocabulary is identical for every caller and every company.', 'additionalProperties': False}

{'type': 'object', 'required': [], 'properties': {}, 'description': 'Takes no arguments: the form and code vocabulary is identical for every caller and every filer.', 'additionalProperties': False}

{'type': 'object', 'required': [], 'properties': {'role': {'enum': ['director', 'officer', 'ten_percent_owner'], 'type': 'string', 'description': 'Restrict to filers the filing marks as a director, an officer (an executive, with their title), or a beneficial owner of more than ten percent of a class. One person can hold several of these at once. Omit to match every role.'}, 'codes': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[A-Za-z]{1,2}$', 'maxLength': 2, 'minLength': 1, 'description': "One Form 3/4/5 transaction code, as published by list_ownership_codes — 'P' an open-market purchase, 'S' an open-market sale, 'A' a grant, 'M' an option exercise or conversion, 'F' shares withheld to satisfy an exercise obligation or a tax liability."}, 'maxItems': 8, 'minItems': 1, 'description': "Transaction codes to include, up to eight of them — for instance ['P'] for open-market purchases or ['P','S'] for open-market decisions in both directions. Omit to match every code. list_ownership_codes publishes the whole vocabulary with what each code actually means; filtering to codes other than S correctly yields no realized proceeds."}, 'limit': {'type': 'integer', 'default': 25, 'maximum': 50, 'minimum': 1, 'description': "People per page, ranked by realized proceeds in the window. Accepts 1 to 50; defaults to 25. A person's row aggregates many transactions, so this page is smaller than the transaction screen's for the same work."}, 'offset': {'type': 'integer', 'default': 0, 'maximum': 199, 'minimum': 0, 'description': 'People to skip in the ranking before this page. Accepts 0 to 199, and offset plus limit must not exceed 200: the ranking is recomputed per request, so paging deeper would re-read the window for every page. Narrow the filters instead.'}, 'end_date': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'maxLength': 10, 'minLength': 10, 'description': 'Latest transaction date to include, inclusive, as YYYY-MM-DD. Leave it out for an open-ended range running to the newest row in the corpus.'}, 'direction': {'enum': ['A', 'D'], 'type': 'string', 'description': "Restrict to acquisitions ('A') or disposals ('D'), read from the filing's own acquired/disposed flag and never derived from the transaction code. A code and a direction disagree routinely: an option exercise disposes of the derivative security while acquiring common stock. Omit to match both."}, 'start_date': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'maxLength': 10, 'minLength': 10, 'description': 'Earliest transaction date to include, inclusive, as YYYY-MM-DD. Matched against the date the transaction happened, not the date the filing arrived — the two differ by days on a Form 4 and by up to a year on a Form 5.'}, 'rule_10b5_1': {'enum': ['under_plan', 'not_under_plan', 'not_stated'], 'type': 'string', 'description': "Rule 10b5-1 status of the transaction: 'under_plan' for sales scheduled in advance under a written plan, 'not_under_plan' for those the filing states were not, and 'not_stated' for filings that say nothing at all — which is every filing before the 2022 amendments and is a different claim from 'not_under_plan'. Omit to apply no filter of any kind."}, 'window_days': {'type': 'integer', 'default': 365, 'maximum': 3650, 'minimum': 1, 'description': 'Trailing window in days, ending today, used when no explicit date range is given. Accepts 1 to 3650; defaults to 365. Supplying start_date or end_date replaces it.'}, 'min_value_usd': {'type': 'string', 'pattern': '^\\d+(\\.\\d+)?$', 'maxLength': 24, 'minLength': 1, 'description': "Minimum transacted value the filing itself stated, as a decimal string such as '250000' or '250000.50'. Rows the filing stated no per-share figure for are never matched by it: an absent figure is not zero, and a gift recorded without one would otherwise satisfy every threshold as a transaction that never happened."}}, 'description': 'Narrows the people to return and sets the window their totals are computed over. Every filter is optional; supplying an explicit date range replaces the trailing window.', 'additionalProperties': False}

{'type': 'object', 'required': [], 'properties': {'role': {'enum': ['director', 'officer', 'ten_percent_owner'], 'type': 'string', 'description': 'Restrict to filers the filing marks as a director, an officer (an executive, with their title), or a beneficial owner of more than ten percent of a class. One person can hold several of these at once. Omit to match every role.'}, 'codes': {'type': 'array', 'items': {'type': 'string', 'pattern': '^[A-Za-z]{1,2}$', 'maxLength': 2, 'minLength': 1, 'description': "One Form 3/4/5 transaction code, as published by list_ownership_codes — 'P' an open-market purchase, 'S' an open-market sale, 'A' a grant, 'M' an option exercise or conversion, 'F' shares withheld to satisfy an exercise obligation or a tax liability."}, 'maxItems': 8, 'minItems': 1, 'description': "Transaction codes to include, up to eight of them — for instance ['P'] for open-market purchases or ['P','S'] for open-market decisions in both directions. Omit to match every code. list_ownership_codes publishes the whole vocabulary with what each code actually means; filtering to codes other than S correctly yields no realized proceeds."}, 'limit': {'type': 'integer', 'default': 50, 'maximum': 100, 'minimum': 1, 'description': 'Transaction rows per page, newest first. Accepts 1 to 100; defaults to 50 when omitted. The ceiling cannot be raised by a parameter and is published in the response.'}, 'offset': {'type': 'integer', 'default': 0, 'maximum': 5000, 'minimum': 0, 'description': 'Rows to skip before this page, for paging through a result set. Accepts 0 to 5000; defaults to 0. Narrow the filters rather than paging deeper.'}, 'end_date': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'maxLength': 10, 'minLength': 10, 'description': 'Latest transaction date to include, inclusive, as YYYY-MM-DD. Leave it out for an open-ended range running to the newest row in the corpus.'}, 'direction': {'enum': ['A', 'D'], 'type': 'string', 'description': "Restrict to acquisitions ('A') or disposals ('D'), read from the filing's own acquired/disposed flag and never derived from the transaction code. A code and a direction disagree routinely: an option exercise disposes of the derivative security while acquiring common stock. Omit to match both."}, 'start_date': {'type': 'string', 'pattern': '^\\d{4}-\\d{2}-\\d{2}$', 'maxLength': 10, 'minLength': 10, 'description': 'Earliest transaction date to include, inclusive, as YYYY-MM-DD. Matched against the date the transaction happened, not the date the filing arrived — the two differ by days on a Form 4 and by up to a year on a Form 5.'}, 'rule_10b5_1': {'enum': ['under_plan', 'not_under_plan', 'not_stated'], 'type': 'string', 'description': "Rule 10b5-1 status of the transaction: 'under_plan' for sales scheduled in advance under a written plan, 'not_under_plan' for those the filing states were not, and 'not_stated' for filings that say nothing at all — which is every filing before the 2022 amendments and is a different claim from 'not_under_plan'. Omit to apply no filter of any kind."}, 'min_value_usd': {'type': 'string', 'pattern': '^\\d+(\\.\\d+)?$', 'maxLength': 24, 'minLength': 1, 'description': "Minimum transacted value the filing itself stated, as a decimal string such as '250000' or '250000.50'. Rows the filing stated no per-share figure for are never matched by it: an absent figure is not zero, and a gift recorded without one would otherwise satisfy every threshold as a transaction that never happened."}}, 'description': 'Narrows the transactions to return. Every filter is optional and they combine; omitting all of them screens the whole corpus, newest transaction first.', 'additionalProperties': False}