Finbar

Populate caller-supplied rows for explicit historical periods. Provide dataset.entity_id, rows with stable id/label/unit/scale, observations (empty for a new dataset), and target_periods as document periods {year, period_type, period}: Y/0 annual, Q/1–4 quarterly, H/1–2 half-year, QC/1–4 cumulative, M/1–12 fiscal monthly, YT/0 or QT/1–4 transitional. Balances use period-end; flows use the reporting interval. No Excel addresses, formulas, row creation or forecasts. May use web search for source discovery; dataset values require Finbar evidence. This starts paid AI work and may take minutes. Actual usage consumes account credits even on cancellation/failure. Reuse idempotency_key for retries. Poll get_dataset_run at its poll_after_seconds interval, then page get_dataset_result; save results within seven days of completion.

build_dataset

Request cancellation of your dataset run. Completed observations remain retrievable; incurred AI usage is still charged. Poll until execution and billing finish; billing_state is independent of execution status.

cancel_dataset_run

Discover effective account document read allowances, including customer overrides. Free and personal plans allow 10 chunks per request; Enterprise allows 100. All plans normally cap each chunk at 10000 Unicode characters, excluding the abbreviation notice; direct item reads can explicitly disable truncation. Requires documents:read; allowances do not grant OAuth scopes. Call before requesting a larger document window.

get_account_permissions

Read a bounded page of dataset observations, corresponding row definitions, changes and diagnostics. limit is an upper bound: default 25, maximum 100. Pages may contain fewer observations to fit 48 KiB; follow next_cursor. Optionally filter row_id and exact period. Follow next_cursor with unchanged filters; assemble pages by row_id and period, not array position. snapshot_status distinguishes interim and final results. Pending targets are still being processed; do not retry them while the run is active. expires_at is this snapshot's expiry; the final snapshot expires seven days after termination. Retrieval uses no AI credits.

get_dataset_result

Poll dataset execution, current activity (research, verification, correcting or finalizing), current_period for Update, usage and next actions. completed_observations counts saved targets including unresolved entries; reaching the total is not completion. Wait for terminal execution status, then fetch results without a cursor for the final snapshot. Billing is separate: open and pending_settlement may alternate during execution. Wait poll_after_seconds between requests.

get_dataset_run

Retrieve one Finbar entity by entity_id.

get_entity

Read company wiki: OVERVIEW, PRODUCTS, GEOGRAPHY, SEGMENTS, and HISTORY. Optionally filter by types; omitted or empty types returns all available sections. Inline source citations are preserved; use read_document with documents:read to fetch cited document content.

get_entity_wiki

Retrieve price history and market metadata for a Finbar entity.

get_market_data

List documents for a Finbar entity with optional type, inclusive period, and tag filters. Results use opaque cursor pagination ordered by report_date descending. The tag field is included when non-empty. A non-empty tag is human-readable, free-form metadata that distinguishes documents with the same type and period. It usually identifies a file format, an indexed part split from a master document, or a subsidiary. In a subsidiary document set, an empty tag normally represents the parent consolidated group statements.

list_documents

Read a paragraph/table item or a bounded document window. Document windows require limit and exactly one of start_index or an opaque cursor, and return next_cursor only when another renderable chunk exists. Use get_account_permissions for your chunk allowance (free/personal: 10; Enterprise: 100). Each chunk normally has a 10000 Unicode character cap. Use disable_truncate=true with item_id only when you specifically need the full text of a previously truncated item. For tables, smaller table_subslice ranges are also available. Responses include effective limits.

read_document