Schema library finance

Return a public-company filing from a public page.

Pass this JSON Schema and a public source URL to/extract/json. Capture filing identity, dates, issuer, form type, and public document links.

Use this schema The JSON file

tabstack.ai/pricing

TEXT

MARKDOWN

LINKS

extract.tsTypeScript

const res = await client.extract.json({
  url: 'https://example.com/pricing',
  json_schema: {
    type: 'object',
    properties: {
      plan: { type: 'string' },
      price: { type: 'number' },
    },
  },
})

res = client.extract.json(
    url='https://example.com/pricing',
    json_schema={
        'type': 'object',
        'properties': {
            'plan': {'type': 'string'},
            'price': {'type': 'number'},
        },
    },
)

tabstack extract json https://example.com/pricing \
  --schema '{"type":"object","properties":{"plan":{"type":"string"},"price":{"type":"number"}}}'

What it captures

Fields in this public-company filing.

SEC or equivalent regulatory filing from a publicly traded company, including financial statements and key metrics.

Field	Type	What it holds
`company_name`	string, required	Legal name of the filing company.
`company_domain`	string	Primary website domain of the company.
`cik`	string	SEC Central Index Key (CIK) number.
`ticker`	string	Stock ticker symbol.
`exchange`	string	Stock exchange where the company is listed.
`filing_type`	string, required	Type of regulatory filing.
`period_of_report`	string, required	The period covered by this report (YYYY-MM-DD).
`filed_date`	string, required	Date the filing was submitted (YYYY-MM-DD).
`document_url`	string	Direct URL to the primary filing document.
`revenue_usd`	number	Total revenue in USD for the reporting period.
`gross_profit_usd`	number	Gross profit in USD.
`operating_income_usd`	number	Operating income (EBIT) in USD.
`net_income_usd`	number	Net income in USD.
`ebitda_usd`	number	EBITDA in USD.
`total_assets_usd`	number	Total assets in USD.
`total_liabilities_usd`	number	Total liabilities in USD.
`cash_and_equivalents_usd`	number	Cash and cash equivalents in USD.
`total_debt_usd`	number	Total debt in USD.
`shares_outstanding`	number	Number of shares outstanding.
`eps_basic`	number	Basic earnings per share.
`eps_diluted`	number	Diluted earnings per share.
`guidance_revenue_low`	number	Low end of revenue guidance in USD.
`guidance_revenue_high`	number	High end of revenue guidance in USD.
`auditor_name`	string	Name of the external auditor.
`page_title`	string	Title of the source page. Tabstack auto-fills this from page metadata when left empty.
`favicon`	string	Favicon URL of the source page. Tabstack auto-fills this from page metadata when left empty.

Example

Inspect and validate the response shape.

The example below is generated from the schema to demonstrate its structure. Edit the object or paste a real response to validate it in your browser.

What it checks

Pass or fail, and the first reason why.

Whether the text parses as JSON, whether the top level is an object, and whether each field the schema requires is present at the declared type. A null is allowed anywhere. Every key you ask for is present. A field the page does not state can come back null, empty, a placeholder number, or a guessed value. Validate values, not just keys.

Example data, not a live response.

Usage

Send the schema with your source URL.

The schema travels with the request rather than living on your account, so the same call can send a trimmed version for one page and the full one for another. Every key you ask for is present. A field the page does not state can come back null, empty, a placeholder number, or a guessed value. Validate values, not just keys.

public.tsTypeScript

import schema from './public-company-filing.json'

const res = await client.extract.json({
  url: 'https://example.com/pricing',
  json_schema: schema,
})

tabstack extract json 'https://example.com/pricing' \
  --schema @./public-company-filing.json

Adaptation

Make the schema match your application.

The schema is a starting point, not a guarantee that every source page contains every field. Three things are worth doing before you write one into your system, and the schema-authoring guide covers the rest.

Remove what you do not need

A shorter schema is a smaller response and fewer fields to handle.

Describe the ambiguous ones

A description tells Extract what to look for when a label could mean two things.

Validate before you store

Check the returned object against the schema rather than trusting it.

Related schemas

Other schemas in this category.

Same category: alternative asset listing.
Same category: angel & seed deal.
Same category: crypto asset.
The job rather than the object: the Extract API.