Generated interface contracts¶
Registry: agent-tool-registry-v16
Envelope: canonical-envelope-v1
Domain payloads: domain-payload-v3
Use argus tool-registry first. This catalog names the normalized contract
kernel; canonical-envelope-v1 is not the current invocation wire shape.
Business calls return CliToolEnvelope (success, result, audit_id);
registry discovery returns a raw AgentToolRegistrySnapshot. For executable
REST schemas use /openapi.json; for MCP use list_tools().inputSchema.
Preserve evidence, time, license, restrictions, errors, and audit identifiers.
Transport argument rules¶
Parameter names below are normalized. Apply each binding's
parameter_aliases before invocation. CLI options replace underscores with
hyphens. comma_separated_string encodings use strings in CLI and MCP;
REST array parameters use JSON arrays. json_value encodings parse the
normalized JSON string into an array/object before sending it to REST.
REST api_key belongs in X-Argus-API-Key, never the JSON body. With OAuth,
omit api_key, institution_id, and caller_id; identity is server-managed.
Use request as_of; effective_as_of is response metadata.
OAuth authorization¶
Signed argus:tools:public grants the reviewed public business whitelist.
Check permission_requirements.default_oauth_access and required signed scopes.
False requires an explicit signed tool grant or an authorized machine
credential, as well as the declared permission scopes. True does not
bypass tenant, purpose, data-license, or output-policy checks.
Tools requiring an explicit grant: none in the current public business registry.
| Tool | CLI | MCP | REST | Input | Payload |
|---|---|---|---|---|---|
entity_search |
entity-search |
entity_search |
/v1/entity-search |
entity_search.input.v1 |
entity_resolution.payload |
entity_resolve |
entity-resolve |
entity_resolve |
/v1/entity-resolve |
entity_resolve.input.v1 |
entity_resolution.payload |
entity_validate |
entity-validate |
entity_validate |
/v1/entity-validate |
entity_validate.input.v1 |
entity_resolution.payload |
provider_catalog |
provider-catalog |
provider_catalog |
/v1/provider-catalog |
provider_catalog.input.v1 |
provider_metadata.payload |
provider_coverage |
provider-coverage |
provider_coverage |
/v1/provider-coverage |
provider_coverage.input.v1 |
provider_metadata.payload |
source_validate |
source-validate |
source_validate |
/v1/source-validate |
source_validate.input.v1 |
provider_metadata.payload |
equity_etf_master |
equity-etf-master |
equity_etf_master |
/v1/equity-etf-master |
equity_etf_master.input.v1 |
security.payload |
us_market_session |
us-market-session |
us_market_session |
/v1/us-market-session |
us_market_session.input.v1 |
market.payload |
etf_data |
etf-data |
etf_data |
/v1/etf-data |
etf_data.input.v1 |
etf.payload |
equity_market_data |
equity-market-data |
equity_market_data |
/v1/equity-market-data |
equity_market_data.input.v1 |
market.payload |
market_bars |
market-bars |
market_bars |
/v1/market-bars |
market_bars.input.v1 |
market.payload |
market_quote |
market-quote |
market_quote |
/v1/market-quote |
market_quote.input.v1 |
market.payload |
market_trades |
market-trades |
market_trades |
/v1/market-trades |
market_trades.input.v1 |
market.payload |
option_chain |
option-chain |
option_chain |
/v1/option-chain |
option_chain.input.v1 |
option.payload |
universe_screen |
universe-screen |
universe_screen |
/v1/universe-screen |
universe_screen.input.v1 |
entity.payload |
dataset_catalog |
dataset-catalog |
dataset_catalog |
/v1/dataset-catalog |
dataset_catalog.input.v1 |
entity.payload |
metric_catalog |
metric-catalog |
metric_catalog |
/v1/metric-catalog |
metric_catalog.input.v1 |
feature.payload |
feature_dag_execute |
feature-dag-execute |
feature_dag_execute |
/v1/feature-dag-execute |
feature_dag_execute.input.v1 |
feature.payload |
multi_source_comparison |
multi-source-comparison |
multi_source_comparison |
/v1/multi-source-comparison |
multi_source_comparison.input.v1 |
feature.payload |
stream_catalog |
stream-catalog |
stream_catalog |
/v1/stream-catalog |
stream_catalog.input.v1 |
stream.payload |
stream_peek |
stream-peek |
stream_peek |
/v1/stream-peek |
stream_peek.input.v1 |
stream.payload |
stream_collect |
stream-collect |
stream_collect |
/v1/stream-collect |
stream_collect.input.v1 |
stream.payload |
stream_refresh |
stream-refresh |
stream_refresh |
/v1/stream-refresh |
stream_refresh.input.v1 |
stream.payload |
stream_subscribe |
stream-subscribe |
stream_subscribe |
/v1/stream-subscribe |
stream_subscribe.input.v1 |
stream.payload |
company_master |
company-master |
company_master |
/v1/company-master |
company_master.input.v1 |
entity.payload |
company_fact_snapshot |
company-fact-snapshot |
company_fact_snapshot |
/v1/company-fact-snapshot |
company_fact_snapshot.input.v1 |
entity.payload |
filing_search |
filing-search |
filing_search |
/v1/filing-search |
filing_search.input.v1 |
filing.payload |
filing_evidence_extract |
filing-evidence-extract |
filing_evidence_extract |
/v1/filing-evidence-extract |
filing_evidence_extract.input.v1 |
filing.payload |
source_evidence_lookup |
source-evidence |
source_evidence_lookup |
/v1/source-evidence |
source_evidence_lookup.input.v1 |
entity.payload |
event_timeline |
event-timeline |
event_timeline |
/v1/event-timeline |
event_timeline.input.v1 |
entity.payload |
market_data_snapshot |
market-data-snapshot |
market_data_snapshot |
/v1/market-data-snapshot |
market_data_snapshot.input.v1 |
market.payload |
point_in_time_snapshot |
point-in-time-snapshot |
point_in_time_snapshot |
/v1/point-in-time-snapshot |
point_in_time_snapshot.input.v1 |
entity.payload |
fundamental_facts |
fundamental-facts |
fundamental_facts |
/v1/fundamental-facts |
fundamental_facts.input.v1 |
filing.payload |
news_discovery |
news-discovery |
news_discovery |
/v1/news-discovery |
news_discovery.input.v1 |
news_discovery.payload |
ir_material_search |
ir-material-search |
ir_material_search |
/v1/ir-material-search |
ir_material_search.input.v1 |
filing.payload |
insider_transactions |
insider-transactions |
insider_transactions |
/v1/insider-transactions |
insider_transactions.input.v1 |
entity.payload |
market_calendar |
market-calendar |
market_calendar |
/v1/market-calendar |
market_calendar.input.v1 |
market.payload |
macro_series |
macro-series |
macro_series |
/v1/macro-series |
macro_series.input.v1 |
macro.payload |
corporate_actions |
corporate-actions |
corporate_actions |
/v1/corporate-actions |
corporate_actions.input.v1 |
market.payload |
data_quality_check |
data-quality-check |
data_quality_check |
/v1/data-quality-check |
data_quality_check.input.v1 |
entity.payload |
point_in_time_dataset_export |
point-in-time-dataset-export |
point_in_time_dataset_export |
/v1/point-in-time-dataset-export |
point_in_time_dataset_export.input.v1 |
entity.payload |
audit_export |
audit-export |
audit_export |
/v1/audit-export |
audit_export.input.v1 |
entity.payload |
data_license_check |
data-license-check |
data_license_check |
/v1/data-license-check |
data_license_check.input.v1 |
entity.payload |
market_session_fact_package |
market-session-fact-package |
market_session_fact_package |
/v1/market-session-fact-package |
market_session_fact_package.input.v1 |
entity.payload |
agent_data_preflight |
agent-data-preflight |
agent_data_preflight |
/v1/agent-data-preflight |
agent_data_preflight.input.v1 |
entity.payload |
data_freshness_manifest |
data-freshness-manifest |
data_freshness_manifest |
/v1/data-freshness-manifest |
data_freshness_manifest.input.v1 |
entity.payload |
evidence_gap_report |
evidence-gap-report |
evidence_gap_report |
/v1/evidence-gap-report |
evidence_gap_report.input.v1 |
entity.payload |
filing_fact_delta_package |
filing-fact-delta-package |
filing_fact_delta_package |
/v1/filing-fact-delta-package |
filing_fact_delta_package.input.v1 |
entity.payload |
field_catalog |
field-catalog |
field_catalog |
/v1/field-catalog |
field_catalog.input.v1 |
provider_metadata.payload |
evidence_bundle_export |
evidence-bundle-export |
evidence_bundle_export |
/v1/evidence-bundle-export |
evidence_bundle_export.input.v1 |
entity.payload |
neutral_event_taxonomy |
neutral-event-taxonomy |
neutral_event_taxonomy |
/v1/neutral-event-taxonomy |
neutral_event_taxonomy.input.v1 |
entity.payload |
agent_compatibility_contracts |
agent-compatibility-contracts |
agent_compatibility_contracts |
/v1/agent-compatibility-contracts |
agent_compatibility_contracts.input.v1 |
entity.payload |
agent_tool_registry |
tool-registry |
agent_tool_registry |
/v1/tool-registry |
agent_tool_registry.input.v1 |
entity.payload |
Unknown REST request fields are invalid. Invocation failures carry
success: false and error.error_code; the error's audit_id may be
audit_not_started if validation failed before core entry. REST schema
validation errors use HTTP 422 with detail. MCP clients must first
check JSON-RPC errors and isError, then decode structuredContent
(or JSON from text content). The kernel's code/field_path/retryable
error shape is a separate contract, not an invocation error decoder.
Generated bindings label it with error_shape_contract and provide
wire_error_shape for governed invocation failures; transport-level
validation still uses HTTP 422, JSON-RPC errors, or CLI usage errors.
entity_search¶
Search point-in-time entity and security identities using structured identifiers or legal names.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| query | string | yes | Identifier or legal-name query. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
entity_resolve¶
Resolve one effective-dated identifier to permanent security identities.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| identifier_type | enum | yes | security_id, entity_id, CIK, LEI, FIGI, ISIN, ticker, MIC, share_class, or ADR; restricted identifiers are excluded. |
| identifier_value | string | yes | Identifier value. |
| mic | string | no | Optional MIC disambiguator. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
entity_validate¶
Validate a point-in-time identifier mapping against an optional permanent security id.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| identifier_type | enum | yes | Identifier type. |
| identifier_value | string | yes | Identifier value. |
| expected_security_id | string | no | Optional expected permanent security id. |
| mic | string | no | Optional MIC disambiguator. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
provider_catalog¶
Return provider versions, identifiers, licenses, and availability restrictions.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
provider_coverage¶
Return coded provider field, identifier, and market coverage.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| provider_id | string | no | Optional provider filter. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
source_validate¶
Validate provider, raw field, mapping version, license, and availability metadata.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| provider_id | string | yes | Provider identifier. |
| source_field | string | yes | Original provider field. |
| mapping_version | string | yes | Mapping version. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
equity_etf_master¶
Return permanent security master and effective-dated listing status facts. Source-backed identifiers and classifications are available where captured; missing listing history, MIC, currency and issuer links remain explicit coverage gaps.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| security_id | string | yes | Permanent security identifier; the prepared production reader accepts exact figi:BBG... identifiers. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
us_market_session¶
Read persisted official exchange calendar facts for the exact MIC and session date, including original hours, source version and evidence.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| session_date | date | yes | US market session date. |
| mic | string | no | Market identifier code. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
etf_data¶
Return ETF profile, historical holdings, NAV, premium-discount, distributions, AUM, fees, benchmark, issuer, and exposure taxonomy.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| security_id | string | yes | ETF permanent security identifier. |
| effective_date | date | no | Optional effective-date cutoff. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
equity_market_data¶
Return quotes, trades, bars, corporate actions, traceable adjustment factors, and symbol mapping events.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| security_id | string | yes | Permanent security identifier. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
market_bars¶
Return strict Bar observations with OHLCV, interval, session, timezone, adjustment and provenance fields.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| security_id | string | yes | Permanent security identifier. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
market_quote¶
Return strict bid/ask Quote observations with size presence and delay status.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| security_id | string | yes | Permanent security identifier. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
market_trades¶
Return completed Trade observations only; Bar and latest-price values are never substituted.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| security_id | string | yes | Permanent security identifier. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
option_chain¶
Return option contract master, chain, quote, open interest, volume, and provider-supplied greeks with model inputs and versions.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| underlying_security_id | string | yes | Underlying permanent security identifier. |
| expiration_date | date | no | Optional expiration date filter. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
universe_screen¶
Filter point-in-time records using allowlisted typed predicates; returns conditions and factual records only.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| filters_json | string | no | JSON array of typed field/operator/value predicates. |
| select | array[string] | no | Allowlisted output fields. |
| sort_json | string | no | JSON array of stable sort fields and directions. |
| page_size | integer | no | Page size, at most 100. |
| cursor | string | no | Cursor bound to the canonical query. |
| max_scan_rows | integer | no | Caller scan limit, at most 10000. |
| max_cost_units | integer | no | Caller cost limit, at most 100000 units. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
- rest:
filters_json→filters. - rest:
sort_json→sort.
dataset_catalog¶
Return typed dataset, field, partition, provider, license, and format metadata.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
metric_catalog¶
Return registered formula ids, versions, typed inputs, units, time semantics, missing-value policies, and test vectors.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
feature_dag_execute¶
Execute only versioned catalog formulas over PIT facts; returns typed derived values, complete lineage, cache identity, and coded errors.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| facts_json | string | yes | JSON array of typed PIT facts with evidence. |
| nodes_json | string | yes | JSON array of allowlisted formula nodes; expressions and code are rejected. |
| outputs | array[string] | yes | Requested DAG node ids. |
| limits_json | string | no | Optional bounded resource limits. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
- rest:
facts_json→facts. - rest:
nodes_json→nodes. - rest:
limits_json→limits.
multi_source_comparison¶
Preserve every source observation and expose pairwise field differences, time, quality, and coverage without choosing a best source or view.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| observations_json | string | yes | JSON array of typed provider field observations. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
- rest:
observations_json→observations.
stream_catalog¶
Return registered structured-data topics, schemas, providers, licenses, TTL, watermark, sequence, cursor, and retention limits.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
stream_peek¶
Read at most one structured event from a signed bounded cursor without any delivery side effect.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| topic | string | yes | Registered stream topic. |
| cursor | string | no | Signed opaque continuation cursor. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
stream_collect¶
Poll a finite structured event window with signed cursor continuation and explicit resource limits.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| topic | string | yes | Registered stream topic. |
| cursor | string | no | Signed opaque continuation cursor. |
| max_events | integer | no | Maximum events, capped by topic and global limits. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
stream_refresh¶
Perform one coalesced, backpressured provider refresh and return a bounded structured event window.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| topic | string | yes | Registered stream topic. |
| max_events | integer | no | Maximum events, capped by topic and global limits. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
stream_subscribe¶
Return a duration- and event-capped structured stream window; this is not a webhook or unbounded subscription.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| topic | string | yes | Registered stream topic. |
| cursor | string | no | Signed opaque continuation cursor. |
| max_events | integer | no | Maximum event count. |
| max_duration_seconds | integer | no | Maximum bounded subscription duration. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
company_master¶
Return company and security master facts with source evidence.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| ticker | string | yes | Security ticker. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
company_fact_snapshot¶
Return disclosed company facts as a structured data package.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| company_id | string | yes | Company identifier. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
filing_search¶
Return filing fragments matching a structured evidence query.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| company_id | string | yes | Company identifier. |
| query | string | yes | Structured evidence query text. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
filing_evidence_extract¶
Return filing fragments selected by caller-supplied structured terms.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| query_terms | array[string] | yes | Structured search terms. |
| filing_document_id | string | no | Optional filing document scope. |
Wire return: CliToolEnvelope JSON with nested filing_evidence_extract DataPackage.
Default OAuth access: true.
source_evidence_lookup¶
Return one source-evidence record by evidence id.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| evidence_id | string | yes | Source evidence identifier. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
event_timeline¶
Return a neutral company event timeline.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| company_id | string | yes | Company identifier. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
market_data_snapshot¶
Return source-backed daily, delayed, or historical market data with observed freshness.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| company_id | string | yes | Stable company identifier. |
| request_type | string | no | Daily, delayed, historical, adjusted, volume, or volatility request. |
| start_time | datetime | no | Optional inclusive market-time start. |
| end_time | datetime | no | Optional inclusive market-time end. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
point_in_time_snapshot¶
Return persisted company financial facts visible as of the requested time, with source evidence and snapshot metadata.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| company_id | string | yes | Company identifier. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
fundamental_facts¶
Query normalized SEC financial facts.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| company_id | string | no | Stable company identifier. |
| symbol | string | no | Security symbol. |
| query | string | no | Optional field/value filter. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
news_discovery¶
Return unconfirmed discovery candidates, conservatively correlate SEC-confirmed events, and expose descriptive versioned sentiment/heat metrics that are not predictions, signals, or advice.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| company_id | string | no | Stable company identifier. |
| symbol | string | no | Security symbol. |
| query | string | no | Discovery query or metadata filter. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
ir_material_search¶
Search normalized investor-relations source material fragments.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| company_id | string | no | Stable company identifier. |
| symbol | string | no | Security symbol. |
| query | string | no | Full-text search term. |
| cursor | string | no | Opaque cursor from the prior page. |
| limit | integer | no | Page size from 1 through 100. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
insider_transactions¶
Query normalized insider transaction facts.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| company_id | string | no | Stable company identifier. |
| symbol | string | no | Security symbol. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
market_calendar¶
Query normalized market calendar facts.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| query | string | no | Optional calendar filter. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
macro_series¶
Query normalized official macro observations.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| series_id | string | no | Official macro series identifier. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
corporate_actions¶
Query source-backed corporate actions with action-specific dates and revisions.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| company_id | string | yes | Stable company identifier. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
data_quality_check¶
Return data quality findings as structured facts.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| company_id | string | yes | Company identifier. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
point_in_time_dataset_export¶
Return an as-of-correct dataset manifest without product analytics or performance evaluation.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| filters_json | string | no | JSON array of typed field/operator/value predicates. |
| select | array[string] | no | Allowlisted export fields. |
| sort_json | string | no | JSON array of stable sort fields and directions. |
| export_format | enum | no | parquet or arrow. |
| partition_by | array[string] | no | session_date and/or mic. |
| period_start | date | no | Inclusive effective session start. |
| period_end | date | no | Inclusive effective session end. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
- rest:
filters_json→filters. - rest:
sort_json→sort.
audit_export¶
Export sanitized audit records with institution, caller, time, tool, status, policy-hit, and audit-id filters.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| audit_id | string | no | Audit identifier filter. |
| target_institution_id | string | no | Institution filter; must match the authenticated institution. |
| target_caller_id | string | no | Machine caller filter. |
| from_time | datetime | no | Inclusive UTC lower timestamp bound. |
| to_time | datetime | no | Inclusive UTC upper timestamp bound. |
| tool_name | string | no | Tool name filter. |
| status | string | no | Audit status filter. |
| offset | integer | no | Pagination offset, from 0 to 1000000. |
| limit | integer | no | Page size, from 1 to 1000; default 100. |
| policy_hit | string | no | Permission, license, schema, or output-origin policy hit filter. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
data_license_check¶
Inspect current configured source terms and the administrative data-use decision; disabled enforcement does not establish authorization or data availability.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| source | string | yes | Configured connector source id, policy source, or versioned license id; current configuration only. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
market_session_fact_package¶
Assemble captured source facts for one US market session using the cited XNYS reference calendar; missing symbols and unverified complete-session coverage remain explicit.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| market | literal[US] | yes | Supported market identifier. |
| session | enum | yes | us_pre_market_close selects source pre-market open up to regular open; us_midday selects regular open up to noon New York time; us_regular_close selects regular open through the actual source close. Daily bars are eligible only for regular close. |
| session_date | date | yes | America/New_York market date. |
| symbols | array[string] | yes | Up to 100 distinct US symbols; .US is the explicit exchange suffix alias. Symbols select captured observations and are never echoed as supplier facts. |
Wire return: CliToolEnvelope JSON with nested market_session_fact_package DataPackage.
Default OAuth access: true.
agent_data_preflight¶
Return permission, license, field, time range, and target-tool preflight metadata.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| subjects | array[string] | yes | Subjects to preflight. |
| field_names | array[string] | yes | Requested fields. |
| target_tool | string | yes | Tool intended for the follow-up request. |
| range_start | datetime | no | Optional range start. |
| range_end | datetime | no | Optional range end. |
Wire return: CliToolEnvelope JSON with nested agent_data_preflight_result DataPackage.
Default OAuth access: true.
- cli:
field_names→fields. - cli:
range_start→from_time. - cli:
range_end→to_time. - mcp:
field_names→fields. - mcp:
range_start→from_time. - mcp:
range_end→to_time.
data_freshness_manifest¶
Return last-ingested, known-at, delay, real-time tradability, license, and quality metadata.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| dataset | string | no | Dataset name. |
| source_id | string | no | Source identifier. |
| subject | string | no | Subject identifier. |
| field_name | string | no | Field name. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
evidence_gap_report¶
Return evidenced, missing, low-quality, conflicting, and license-blocked classifications.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| subject | string | no | Subject identifier. |
| field_names | array[string] | no | Fields to classify. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
- cli:
field_names→fields. - mcp:
field_names→fields.
filing_fact_delta_package¶
Return structured fact changes between filings, snapshots, or known-at points.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| subject | string | no | Subject identifier. |
| baseline_known_at | datetime | no | Baseline known-at timestamp. |
| comparison_known_at | datetime | no | Comparison known-at timestamp. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
field_catalog¶
Return normalized fields with provider, raw field, mapping version, license, restrictions, and quality semantics.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| field_names | array[string] | no | Optional field filter. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
- cli:
field_names→fields. - mcp:
field_names→fields.
evidence_bundle_export¶
Export the caller's archived governed public facts and evidence with verified content checksum and preserved license restrictions.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
| source_package_id | string | no | Source package identifier: data_package: followed by the audit identifier of a successful call. Only the original caller and institution may export it; the REST guide identifies the response field. |
| include_restricted | boolean | no | Whether restricted content is requested; the export always retains the governed public projection and never expands access. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
neutral_event_taxonomy¶
Return neutral event type definitions without sentiment, price impact, or trading meaning.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
agent_compatibility_contracts¶
Return stage three/four compatibility contracts, registry descriptions, and test matrix only.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| api_key | string | no | Machine credential for authenticated access. |
| institution_id | string | no | Institution scope for policy checks. |
| caller_id | string | no | Machine caller id expected to match credentials. |
| purpose | string | no | Request purpose checked by policy. |
| as_of | datetime | no | Point-in-time timestamp for as-of-safe queries. |
| requires_redistribution | boolean | no | Whether downstream redistribution is requested. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: true.
agent_tool_registry¶
Return the machine-readable registry of exposed agent tools.
| Parameter | Type | Required | Description | | --- | --- | --- | --- | --- |
Wire return: AgentToolRegistrySnapshot JSON.
Default OAuth access: true.