Generated interface contracts¶
Registry: agent-tool-registry-v20
Envelope: canonical-envelope-v1
Domain payloads: domain-payload-v5
Use argus tool-registry first. This catalog names the normalized contract
kernel; canonical-envelope-v1 is not the current invocation wire shape.
Existing financial calls return CliToolEnvelope (success, result, audit_id);
Personal calls return personal-result-v1 with result_kind, payload,
problem, request_id and audit_id; payloads bind owner/lifecycle/domain
and the declared business DTO in data. They never reinterpret notes as facts.
Personal CLI commands take --request-file containing the same JSON request
as REST/MCP. Private source content remains subject to current source rights.
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.
Personal access uses registered OAuth sessions. Identity is server-managed;
no institution identifier or caller identifier is part of the public input.
Use request as_of; effective_as_of is response metadata.
OAuth authorization¶
Signed argus:tools:public grants the reviewed public business whitelist.
New signed argus:tools:personal-facts with facts:read evidence:read grants
company/ETF details, objective comparison and the filing fact workflow.
An explicit signed tool whitelist, including an empty one, takes precedence.
Old fact-only authorizations do not gain these four compositions.
Check permission_requirements.default_oauth_access and required signed scopes.
Personal tools require their signed domain scopes plus current owner consent;
search and confirmation check the requested domains/target operation. Old
fact scopes grant no private access. Sensitive account actions require the
separate cookie/CSRF account API in release/personal-management.v1.json.
Advanced and diagnostic tools require explicit signed tool grants or the
argus:tools:advanced / argus:tools:diagnostics discovery scope plus
the required data scopes. Discovery never grants private domain access.
Tools requiring an explicit grant: entity_validate, provider_catalog, provider_coverage, source_validate, market_quote, market_trades, option_chain, universe_screen, dataset_catalog, metric_catalog, feature_dag_execute, multi_source_comparison, stream_catalog, stream_peek, stream_collect, stream_refresh, stream_subscribe, data_quality_check, point_in_time_dataset_export, data_license_check, agent_data_preflight, data_freshness_manifest, evidence_gap_report, field_catalog, neutral_event_taxonomy, personal_saved_queries_create_v1, personal_saved_queries_update_v1, personal_saved_queries_delete_v1, personal_saved_queries_read_v1, personal_saved_queries_list_v1, personal_holding_snapshots_create_v1, personal_holding_snapshots_update_v1, personal_holding_snapshots_delete_v1, personal_holding_snapshots_read_v1, personal_holding_snapshots_list_v1, personal_income_records_create_v1, personal_income_records_update_v1, personal_income_records_delete_v1, personal_income_records_read_v1, personal_income_records_list_v1, personal_saved_queries_rerun_v1, personal_watchlists_create_v1, personal_watchlists_update_v1, personal_watchlists_read_v1, personal_watchlists_list_v1, personal_watchlists_delete_v1, personal_watchlists_members_add_v1, personal_watchlists_members_remove_v1, personal_watchlists_members_read_v1, personal_watchlists_deletion_impact_v1, personal_watchlists_resolve_v1, personal_notes_create_v1, personal_notes_update_v1, personal_notes_delete_v1, personal_notes_read_v1, personal_notes_search_v1, personal_bookmarks_create_v1, personal_bookmarks_update_v1, personal_bookmarks_delete_v1, personal_bookmarks_read_v1, personal_bookmarks_list_v1, personal_subscriptions_create_v1, personal_subscriptions_update_v1, personal_subscriptions_pause_v1, personal_subscriptions_resume_v1, personal_subscriptions_delete_v1, personal_subscriptions_read_v1, personal_subscriptions_list_v1, personal_notifications_read_v1, personal_notifications_collect_v1, personal_notifications_detail_v1, personal_notifications_mark_read_v1, personal_imports_preview_v1, personal_imports_read_v1, personal_imports_commit_v1, personal_income_summary_v1, personal_valuations_read_v1, personal_exports_create_v1, personal_exports_status_v1, personal_exports_download_v1, personal_preferences_read_v1, personal_preferences_update_v1, personal_account_read_v1, personal_account_guide_v1, personal_sessions_read_v1, personal_usage_read_v1, personal_search_read_v1, personal_company_detail_read_v1, personal_etf_detail_read_v1, personal_comparison_read_v1, personal_filing_workflow_read_v1, personal_confirmation_prepare_v1.
| 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.v2 |
market.payload |
market_bars |
market-bars |
market_bars |
/v1/market-bars |
market_bars.input.v2 |
market.payload |
market_quote |
market-quote |
market_quote |
/v1/market-quote |
market_quote.input.v2 |
market.payload |
market_trades |
market-trades |
market_trades |
/v1/market-trades |
market_trades.input.v2 |
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 |
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.v2 |
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_tool_registry |
tool-registry |
agent_tool_registry |
/v1/tool-registry |
agent_tool_registry.input.v1 |
entity.payload |
personal_saved_queries_create_v1 |
personal-saved-queries-create-v1 |
personal_saved_queries_create_v1 |
/v1/personal/saved-queries-create |
personal_saved_queries_create_v1.input.v1 |
personal_saved_queries_create_v1.result.v1 |
personal_saved_queries_update_v1 |
personal-saved-queries-update-v1 |
personal_saved_queries_update_v1 |
/v1/personal/saved-queries-update |
personal_saved_queries_update_v1.input.v1 |
personal_saved_queries_update_v1.result.v1 |
personal_saved_queries_delete_v1 |
personal-saved-queries-delete-v1 |
personal_saved_queries_delete_v1 |
/v1/personal/saved-queries-delete |
personal_saved_queries_delete_v1.input.v1 |
personal_saved_queries_delete_v1.result.v1 |
personal_saved_queries_read_v1 |
personal-saved-queries-read-v1 |
personal_saved_queries_read_v1 |
/v1/personal/saved-queries-read |
personal_saved_queries_read_v1.input.v1 |
personal_saved_queries_read_v1.result.v1 |
personal_saved_queries_list_v1 |
personal-saved-queries-list-v1 |
personal_saved_queries_list_v1 |
/v1/personal/saved-queries-list |
personal_saved_queries_list_v1.input.v1 |
personal_saved_queries_list_v1.result.v1 |
personal_holding_snapshots_create_v1 |
personal-holding-snapshots-create-v1 |
personal_holding_snapshots_create_v1 |
/v1/personal/holding-snapshots-create |
personal_holding_snapshots_create_v1.input.v1 |
personal_holding_snapshots_create_v1.result.v1 |
personal_holding_snapshots_update_v1 |
personal-holding-snapshots-update-v1 |
personal_holding_snapshots_update_v1 |
/v1/personal/holding-snapshots-update |
personal_holding_snapshots_update_v1.input.v1 |
personal_holding_snapshots_update_v1.result.v1 |
personal_holding_snapshots_delete_v1 |
personal-holding-snapshots-delete-v1 |
personal_holding_snapshots_delete_v1 |
/v1/personal/holding-snapshots-delete |
personal_holding_snapshots_delete_v1.input.v1 |
personal_holding_snapshots_delete_v1.result.v1 |
personal_holding_snapshots_read_v1 |
personal-holding-snapshots-read-v1 |
personal_holding_snapshots_read_v1 |
/v1/personal/holding-snapshots-read |
personal_holding_snapshots_read_v1.input.v1 |
personal_holding_snapshots_read_v1.result.v1 |
personal_holding_snapshots_list_v1 |
personal-holding-snapshots-list-v1 |
personal_holding_snapshots_list_v1 |
/v1/personal/holding-snapshots-list |
personal_holding_snapshots_list_v1.input.v1 |
personal_holding_snapshots_list_v1.result.v1 |
personal_income_records_create_v1 |
personal-income-records-create-v1 |
personal_income_records_create_v1 |
/v1/personal/income-records-create |
personal_income_records_create_v1.input.v1 |
personal_income_records_create_v1.result.v1 |
personal_income_records_update_v1 |
personal-income-records-update-v1 |
personal_income_records_update_v1 |
/v1/personal/income-records-update |
personal_income_records_update_v1.input.v1 |
personal_income_records_update_v1.result.v1 |
personal_income_records_delete_v1 |
personal-income-records-delete-v1 |
personal_income_records_delete_v1 |
/v1/personal/income-records-delete |
personal_income_records_delete_v1.input.v1 |
personal_income_records_delete_v1.result.v1 |
personal_income_records_read_v1 |
personal-income-records-read-v1 |
personal_income_records_read_v1 |
/v1/personal/income-records-read |
personal_income_records_read_v1.input.v1 |
personal_income_records_read_v1.result.v1 |
personal_income_records_list_v1 |
personal-income-records-list-v1 |
personal_income_records_list_v1 |
/v1/personal/income-records-list |
personal_income_records_list_v1.input.v1 |
personal_income_records_list_v1.result.v1 |
personal_saved_queries_rerun_v1 |
personal-saved-queries-rerun-v1 |
personal_saved_queries_rerun_v1 |
/v1/personal/saved-queries-rerun |
personal_saved_queries_rerun_v1.input.v1 |
personal_saved_queries_rerun_v1.result.v1 |
personal_watchlists_create_v1 |
personal-watchlists-create-v1 |
personal_watchlists_create_v1 |
/v1/personal/watchlists-create |
personal_watchlists_create_v1.input.v1 |
personal_watchlists_create_v1.result.v1 |
personal_watchlists_update_v1 |
personal-watchlists-update-v1 |
personal_watchlists_update_v1 |
/v1/personal/watchlists-update |
personal_watchlists_update_v1.input.v1 |
personal_watchlists_update_v1.result.v1 |
personal_watchlists_read_v1 |
personal-watchlists-read-v1 |
personal_watchlists_read_v1 |
/v1/personal/watchlists-read |
personal_watchlists_read_v1.input.v1 |
personal_watchlists_read_v1.result.v1 |
personal_watchlists_list_v1 |
personal-watchlists-list-v1 |
personal_watchlists_list_v1 |
/v1/personal/watchlists-list |
personal_watchlists_list_v1.input.v1 |
personal_watchlists_list_v1.result.v1 |
personal_watchlists_delete_v1 |
personal-watchlists-delete-v1 |
personal_watchlists_delete_v1 |
/v1/personal/watchlists-delete |
personal_watchlists_delete_v1.input.v1 |
personal_watchlists_delete_v1.result.v1 |
personal_watchlists_members_add_v1 |
personal-watchlists-members-add-v1 |
personal_watchlists_members_add_v1 |
/v1/personal/watchlists-members-add |
personal_watchlists_members_add_v1.input.v1 |
personal_watchlists_members_add_v1.result.v1 |
personal_watchlists_members_remove_v1 |
personal-watchlists-members-remove-v1 |
personal_watchlists_members_remove_v1 |
/v1/personal/watchlists-members-remove |
personal_watchlists_members_remove_v1.input.v1 |
personal_watchlists_members_remove_v1.result.v1 |
personal_watchlists_members_read_v1 |
personal-watchlists-members-read-v1 |
personal_watchlists_members_read_v1 |
/v1/personal/watchlists-members-read |
personal_watchlists_members_read_v1.input.v1 |
personal_watchlists_members_read_v1.result.v1 |
personal_watchlists_deletion_impact_v1 |
personal-watchlists-deletion-impact-v1 |
personal_watchlists_deletion_impact_v1 |
/v1/personal/watchlists-deletion-impact |
personal_watchlists_deletion_impact_v1.input.v1 |
personal_watchlists_deletion_impact_v1.result.v1 |
personal_watchlists_resolve_v1 |
personal-watchlists-resolve-v1 |
personal_watchlists_resolve_v1 |
/v1/personal/watchlists-resolve |
personal_watchlists_resolve_v1.input.v1 |
personal_watchlists_resolve_v1.result.v1 |
personal_notes_create_v1 |
personal-notes-create-v1 |
personal_notes_create_v1 |
/v1/personal/notes-create |
personal_notes_create_v1.input.v1 |
personal_notes_create_v1.result.v1 |
personal_notes_update_v1 |
personal-notes-update-v1 |
personal_notes_update_v1 |
/v1/personal/notes-update |
personal_notes_update_v1.input.v1 |
personal_notes_update_v1.result.v1 |
personal_notes_delete_v1 |
personal-notes-delete-v1 |
personal_notes_delete_v1 |
/v1/personal/notes-delete |
personal_notes_delete_v1.input.v1 |
personal_notes_delete_v1.result.v1 |
personal_notes_read_v1 |
personal-notes-read-v1 |
personal_notes_read_v1 |
/v1/personal/notes-read |
personal_notes_read_v1.input.v1 |
personal_notes_read_v1.result.v1 |
personal_notes_search_v1 |
personal-notes-search-v1 |
personal_notes_search_v1 |
/v1/personal/notes-search |
personal_notes_search_v1.input.v1 |
personal_notes_search_v1.result.v1 |
personal_bookmarks_create_v1 |
personal-bookmarks-create-v1 |
personal_bookmarks_create_v1 |
/v1/personal/bookmarks-create |
personal_bookmarks_create_v1.input.v1 |
personal_bookmarks_create_v1.result.v1 |
personal_bookmarks_update_v1 |
personal-bookmarks-update-v1 |
personal_bookmarks_update_v1 |
/v1/personal/bookmarks-update |
personal_bookmarks_update_v1.input.v1 |
personal_bookmarks_update_v1.result.v1 |
personal_bookmarks_delete_v1 |
personal-bookmarks-delete-v1 |
personal_bookmarks_delete_v1 |
/v1/personal/bookmarks-delete |
personal_bookmarks_delete_v1.input.v1 |
personal_bookmarks_delete_v1.result.v1 |
personal_bookmarks_read_v1 |
personal-bookmarks-read-v1 |
personal_bookmarks_read_v1 |
/v1/personal/bookmarks-read |
personal_bookmarks_read_v1.input.v1 |
personal_bookmarks_read_v1.result.v1 |
personal_bookmarks_list_v1 |
personal-bookmarks-list-v1 |
personal_bookmarks_list_v1 |
/v1/personal/bookmarks-list |
personal_bookmarks_list_v1.input.v1 |
personal_bookmarks_list_v1.result.v1 |
personal_subscriptions_create_v1 |
personal-subscriptions-create-v1 |
personal_subscriptions_create_v1 |
/v1/personal/subscriptions-create |
personal_subscriptions_create_v1.input.v1 |
personal_subscriptions_create_v1.result.v1 |
personal_subscriptions_update_v1 |
personal-subscriptions-update-v1 |
personal_subscriptions_update_v1 |
/v1/personal/subscriptions-update |
personal_subscriptions_update_v1.input.v1 |
personal_subscriptions_update_v1.result.v1 |
personal_subscriptions_pause_v1 |
personal-subscriptions-pause-v1 |
personal_subscriptions_pause_v1 |
/v1/personal/subscriptions-pause |
personal_subscriptions_pause_v1.input.v1 |
personal_subscriptions_pause_v1.result.v1 |
personal_subscriptions_resume_v1 |
personal-subscriptions-resume-v1 |
personal_subscriptions_resume_v1 |
/v1/personal/subscriptions-resume |
personal_subscriptions_resume_v1.input.v1 |
personal_subscriptions_resume_v1.result.v1 |
personal_subscriptions_delete_v1 |
personal-subscriptions-delete-v1 |
personal_subscriptions_delete_v1 |
/v1/personal/subscriptions-delete |
personal_subscriptions_delete_v1.input.v1 |
personal_subscriptions_delete_v1.result.v1 |
personal_subscriptions_read_v1 |
personal-subscriptions-read-v1 |
personal_subscriptions_read_v1 |
/v1/personal/subscriptions-read |
personal_subscriptions_read_v1.input.v1 |
personal_subscriptions_read_v1.result.v1 |
personal_subscriptions_list_v1 |
personal-subscriptions-list-v1 |
personal_subscriptions_list_v1 |
/v1/personal/subscriptions-list |
personal_subscriptions_list_v1.input.v1 |
personal_subscriptions_list_v1.result.v1 |
personal_notifications_read_v1 |
personal-notifications-read-v1 |
personal_notifications_read_v1 |
/v1/personal/notifications-read |
personal_notifications_read_v1.input.v1 |
personal_notifications_read_v1.result.v1 |
personal_notifications_collect_v1 |
personal-notifications-collect-v1 |
personal_notifications_collect_v1 |
/v1/personal/notifications-collect |
personal_notifications_collect_v1.input.v1 |
personal_notifications_collect_v1.result.v1 |
personal_notifications_detail_v1 |
personal-notifications-detail-v1 |
personal_notifications_detail_v1 |
/v1/personal/notifications-detail |
personal_notifications_detail_v1.input.v1 |
personal_notifications_detail_v1.result.v1 |
personal_notifications_mark_read_v1 |
personal-notifications-mark-read-v1 |
personal_notifications_mark_read_v1 |
/v1/personal/notifications-mark-read |
personal_notifications_mark_read_v1.input.v1 |
personal_notifications_mark_read_v1.result.v1 |
personal_imports_preview_v1 |
personal-imports-preview-v1 |
personal_imports_preview_v1 |
/v1/personal/imports-preview |
personal_imports_preview_v1.input.v1 |
personal_imports_preview_v1.result.v1 |
personal_imports_read_v1 |
personal-imports-read-v1 |
personal_imports_read_v1 |
/v1/personal/imports-read |
personal_imports_read_v1.input.v1 |
personal_imports_read_v1.result.v1 |
personal_imports_commit_v1 |
personal-imports-commit-v1 |
personal_imports_commit_v1 |
/v1/personal/imports-commit |
personal_imports_commit_v1.input.v1 |
personal_imports_commit_v1.result.v1 |
personal_income_summary_v1 |
personal-income-summary-v1 |
personal_income_summary_v1 |
/v1/personal/income-summary |
personal_income_summary_v1.input.v1 |
personal_income_summary_v1.result.v1 |
personal_valuations_read_v1 |
personal-valuations-read-v1 |
personal_valuations_read_v1 |
/v1/personal/valuations-read |
personal_valuations_read_v1.input.v1 |
personal_valuations_read_v1.result.v1 |
personal_exports_create_v1 |
personal-exports-create-v1 |
personal_exports_create_v1 |
/v1/personal/exports-create |
personal_exports_create_v1.input.v1 |
personal_exports_create_v1.result.v1 |
personal_exports_status_v1 |
personal-exports-status-v1 |
personal_exports_status_v1 |
/v1/personal/exports-status |
personal_exports_status_v1.input.v1 |
personal_exports_status_v1.result.v1 |
personal_exports_download_v1 |
personal-exports-download-v1 |
personal_exports_download_v1 |
/v1/personal/exports-download |
personal_exports_download_v1.input.v1 |
personal_exports_download_v1.result.v1 |
personal_preferences_read_v1 |
personal-preferences-read-v1 |
personal_preferences_read_v1 |
/v1/personal/preferences-read |
personal_preferences_read_v1.input.v1 |
personal_preferences_read_v1.result.v1 |
personal_preferences_update_v1 |
personal-preferences-update-v1 |
personal_preferences_update_v1 |
/v1/personal/preferences-update |
personal_preferences_update_v1.input.v1 |
personal_preferences_update_v1.result.v1 |
personal_account_read_v1 |
personal-account-read-v1 |
personal_account_read_v1 |
/v1/personal/account-read |
personal_account_read_v1.input.v1 |
personal_account_read_v1.result.v1 |
personal_account_guide_v1 |
personal-account-guide-v1 |
personal_account_guide_v1 |
/v1/personal/account-guide |
personal_account_guide_v1.input.v1 |
personal_account_guide_v1.result.v1 |
personal_sessions_read_v1 |
personal-sessions-read-v1 |
personal_sessions_read_v1 |
/v1/personal/sessions-read |
personal_sessions_read_v1.input.v1 |
personal_sessions_read_v1.result.v1 |
personal_usage_read_v1 |
personal-usage-read-v1 |
personal_usage_read_v1 |
/v1/personal/usage-read |
personal_usage_read_v1.input.v1 |
personal_usage_read_v1.result.v1 |
personal_search_read_v1 |
personal-search-read-v1 |
personal_search_read_v1 |
/v1/personal/search-read |
personal_search_read_v1.input.v1 |
personal_search_read_v1.result.v1 |
personal_company_detail_read_v1 |
personal-company-detail-read-v1 |
personal_company_detail_read_v1 |
/v1/personal/company-detail-read |
personal_company_detail_read_v1.input.v1 |
personal_company_detail_read_v1.result.v1 |
personal_etf_detail_read_v1 |
personal-etf-detail-read-v1 |
personal_etf_detail_read_v1 |
/v1/personal/etf-detail-read |
personal_etf_detail_read_v1.input.v1 |
personal_etf_detail_read_v1.result.v1 |
personal_comparison_read_v1 |
personal-comparison-read-v1 |
personal_comparison_read_v1 |
/v1/personal/comparison-read |
personal_comparison_read_v1.input.v1 |
personal_comparison_read_v1.result.v1 |
personal_filing_workflow_read_v1 |
personal-filing-workflow-read-v1 |
personal_filing_workflow_read_v1 |
/v1/personal/filing-workflow-read |
personal_filing_workflow_read_v1.input.v1 |
personal_filing_workflow_read_v1.result.v1 |
personal_confirmation_prepare_v1 |
personal-confirmation-prepare-v1 |
personal_confirmation_prepare_v1 |
/v1/personal/confirmation-prepare |
personal_confirmation_prepare_v1.input.v1 |
personal_confirmation_prepare_v1.result.v1 |
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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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: false.
provider_catalog¶
Return provider versions, identifiers, licenses, and availability restrictions.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| 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: false.
provider_coverage¶
Return coded provider field, identifier, and market coverage.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| 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: false.
source_validate¶
Validate provider, raw field, mapping version, license, and availability metadata.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| 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: false.
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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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. |
| start_time | datetime | no | Inclusive observation event-time start. |
| end_time | datetime | no | Inclusive observation event-time end. |
| limit | integer | no | Requested observation upper bound: default 100, maximum 200; complete source bundles are returned in pages of at most 25; follow next_cursor. |
| cursor | string | no | Opaque continuation. Keep the same explicit as_of, caller, purpose and time window. Continue until next_cursor is absent; partial coverage remains independent. |
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 |
| --- | --- | --- | --- | --- |
| 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. |
| start_time | datetime | no | Inclusive observation event-time start. |
| end_time | datetime | no | Inclusive observation event-time end. |
| limit | integer | no | Requested observation upper bound: default 100, maximum 200; complete source bundles are returned in pages of at most 25; follow next_cursor. |
| cursor | string | no | Opaque continuation. Keep the same explicit as_of, caller, purpose and time window. Continue until next_cursor is absent; partial coverage remains independent. |
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 |
| --- | --- | --- | --- | --- |
| 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. |
| start_time | datetime | no | Inclusive observation event-time start. |
| end_time | datetime | no | Inclusive observation event-time end. |
| limit | integer | no | Requested observation upper bound: default 100, maximum 200; complete source bundles are returned in pages of at most 25; follow next_cursor. |
| cursor | string | no | Opaque continuation. Keep the same explicit as_of, caller, purpose and time window. Continue until next_cursor is absent; partial coverage remains independent. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: false.
market_trades¶
Return completed Trade observations only; Bar and latest-price values are never substituted.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| 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. |
| start_time | datetime | no | Inclusive observation event-time start. |
| end_time | datetime | no | Inclusive observation event-time end. |
| limit | integer | no | Requested observation upper bound: default 100, maximum 200; complete source bundles are returned in pages of at most 25; follow next_cursor. |
| cursor | string | no | Opaque continuation. Keep the same explicit as_of, caller, purpose and time window. Continue until next_cursor is absent; partial coverage remains independent. |
Wire return: CliToolEnvelope JSON with nested DataPackage result.
Default OAuth access: false.
option_chain¶
Return option contract master, chain, quote, open interest, volume, and provider-supplied greeks with model inputs and versions.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| 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: false.
universe_screen¶
Filter point-in-time records using allowlisted typed predicates; returns conditions and factual records only.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| 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: false.
- rest:
filters_json→filters. - rest:
sort_json→sort.
dataset_catalog¶
Return typed dataset, field, partition, provider, license, and format metadata.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| 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: false.
metric_catalog¶
Return registered formula ids, versions, typed inputs, units, time semantics, missing-value policies, and test vectors.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| 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: false.
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 |
| --- | --- | --- | --- | --- |
| 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: false.
- 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 |
| --- | --- | --- | --- | --- |
| 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: false.
- 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 |
| --- | --- | --- | --- | --- |
| 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: false.
stream_peek¶
Read at most one structured event from a signed bounded cursor without any delivery side effect.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| 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: false.
stream_collect¶
Poll a finite structured event window with signed cursor continuation and explicit resource limits.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| 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: false.
stream_refresh¶
Perform one coalesced, backpressured provider refresh and return a bounded structured event window.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| 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: false.
stream_subscribe¶
Return a duration- and event-capped structured stream window; this is not a webhook or unbounded subscription.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| 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: false.
company_master¶
Return company and security master facts with source evidence.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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: false.
point_in_time_dataset_export¶
Return an as-of-correct dataset manifest without product analytics or performance evaluation.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| 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: false.
- cli:
export_format→format. - rest:
filters_json→filters. - rest:
sort_json→sort.
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 |
| --- | --- | --- | --- | --- |
| 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: false.
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 |
| --- | --- | --- | --- | --- |
| 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. |
| limit | integer | no | Market observation facts per page, default 100, range 1..200; cited calendar facts repeat as context. |
| cursor | string | no | Use next_cursor with the same as_of, session, symbols, caller, institution and purpose. Terminal continuation does not prove full-session coverage. |
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 |
| --- | --- | --- | --- | --- |
| 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: false.
- cli:
field_names→fields. - cli:
range_start→from. - cli:
range_end→to. - 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 |
| --- | --- | --- | --- | --- |
| 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: false.
- cli:
field_name→field.
evidence_gap_report¶
Return evidenced, missing, low-quality, conflicting, and license-blocked classifications.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| 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: false.
- 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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: false.
- 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 |
| --- | --- | --- | --- | --- |
| 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 |
| --- | --- | --- | --- | --- |
| 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: false.
agent_tool_registry¶
Return the machine-readable registry of exposed agent tools.
| Parameter | Type | Required | Description | | --- | --- | --- | --- | --- |
Wire return: AgentToolRegistrySnapshot JSON.
Default OAuth access: true.
personal_saved_queries_create_v1¶
saved_queries_create; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| document | object | yes | Typed document; see the executable input schema. |
Wire return: PersonalSavedQueriesCreateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_saved_queries_update_v1¶
saved_queries_update; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| document | object | yes | Typed document; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
Wire return: PersonalSavedQueriesUpdateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_saved_queries_delete_v1¶
saved_queries_delete; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
| confirmation_id | object | no | Typed confirmation_id; see the executable input schema. |
Wire return: PersonalSavedQueriesDeleteV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_saved_queries_read_v1¶
saved_queries_read; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
Wire return: PersonalSavedQueriesReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_saved_queries_list_v1¶
saved_queries_list; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| page_size | integer | no | Typed page_size; see the executable input schema. |
| cursor | object | no | Typed cursor; see the executable input schema. |
| keyword | string | no | Typed keyword; see the executable input schema. |
Wire return: PersonalSavedQueriesListV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_holding_snapshots_create_v1¶
holding_snapshots_create; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| document | object | yes | Typed document; see the executable input schema. |
Wire return: PersonalHoldingSnapshotsCreateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_holding_snapshots_update_v1¶
holding_snapshots_update; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| document | object | yes | Typed document; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
Wire return: PersonalHoldingSnapshotsUpdateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_holding_snapshots_delete_v1¶
holding_snapshots_delete; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
| confirmation_id | object | no | Typed confirmation_id; see the executable input schema. |
Wire return: PersonalHoldingSnapshotsDeleteV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_holding_snapshots_read_v1¶
holding_snapshots_read; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
Wire return: PersonalHoldingSnapshotsReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_holding_snapshots_list_v1¶
holding_snapshots_list; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| page_size | integer | no | Typed page_size; see the executable input schema. |
| cursor | object | no | Typed cursor; see the executable input schema. |
| keyword | string | no | Typed keyword; see the executable input schema. |
Wire return: PersonalHoldingSnapshotsListV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_income_records_create_v1¶
income_records_create; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| document | object | yes | Typed document; see the executable input schema. |
Wire return: PersonalIncomeRecordsCreateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_income_records_update_v1¶
income_records_update; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| document | object | yes | Typed document; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
Wire return: PersonalIncomeRecordsUpdateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_income_records_delete_v1¶
income_records_delete; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
| confirmation_id | object | no | Typed confirmation_id; see the executable input schema. |
Wire return: PersonalIncomeRecordsDeleteV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_income_records_read_v1¶
income_records_read; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
Wire return: PersonalIncomeRecordsReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_income_records_list_v1¶
income_records_list; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| page_size | integer | no | Typed page_size; see the executable input schema. |
| cursor | object | no | Typed cursor; see the executable input schema. |
| keyword | string | no | Typed keyword; see the executable input schema. |
Wire return: PersonalIncomeRecordsListV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_saved_queries_rerun_v1¶
saved_queries_rerun; typed financial_composite; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
Wire return: PersonalSavedQueriesRerunV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_watchlists_create_v1¶
watchlists_create; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| title | string | yes | Typed title; see the executable input schema. |
| description | string | no | Typed description; see the executable input schema. |
Wire return: PersonalWatchlistsCreateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_watchlists_update_v1¶
watchlists_update; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| title | string | yes | Typed title; see the executable input schema. |
| description | string | no | Typed description; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
Wire return: PersonalWatchlistsUpdateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_watchlists_read_v1¶
watchlists_read; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
Wire return: PersonalWatchlistsReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_watchlists_list_v1¶
watchlists_list; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| page_size | integer | no | Typed page_size; see the executable input schema. |
| cursor | object | no | Typed cursor; see the executable input schema. |
| keyword | string | no | Typed keyword; see the executable input schema. |
Wire return: PersonalWatchlistsListV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_watchlists_delete_v1¶
watchlists_delete; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: bound_owner_approval_if_dependencies. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
| confirmation_id | object | no | Typed confirmation_id; see the executable input schema. |
Wire return: PersonalWatchlistsDeleteV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_watchlists_members_add_v1¶
watchlists_members_add; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| security_ids | object | yes | Typed security_ids; see the executable input schema. |
Wire return: PersonalWatchlistsMembersAddV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_watchlists_members_remove_v1¶
watchlists_members_remove; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: bound_owner_approval_if_over_50_members. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| security_ids | object | yes | Typed security_ids; see the executable input schema. |
| confirmation_id | object | no | Typed confirmation_id; see the executable input schema. |
Wire return: PersonalWatchlistsMembersRemoveV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_watchlists_members_read_v1¶
watchlists_members_read; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| page_size | integer | no | Typed page_size; see the executable input schema. |
| cursor | object | no | Typed cursor; see the executable input schema. |
| keyword | string | no | Typed keyword; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
Wire return: PersonalWatchlistsMembersReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_watchlists_deletion_impact_v1¶
watchlists_deletion_impact; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
Wire return: PersonalWatchlistsDeletionImpactV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_watchlists_resolve_v1¶
watchlists_resolve; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| ticker | string | yes | Typed ticker; see the executable input schema. |
| exchange_code | object | no | Typed exchange_code; see the executable input schema. |
Wire return: PersonalWatchlistsResolveV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_notes_create_v1¶
notes_create; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| content | object | yes | Typed content; see the executable input schema. |
| description | string | no | Typed description; see the executable input schema. |
| source_references | object | no | Typed source_references; see the executable input schema. |
| note_kind | object | no | Typed note_kind; see the executable input schema. |
Wire return: PersonalNotesCreateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_notes_update_v1¶
notes_update; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| content | object | yes | Typed content; see the executable input schema. |
| description | string | no | Typed description; see the executable input schema. |
| source_references | object | no | Typed source_references; see the executable input schema. |
| note_kind | object | no | Typed note_kind; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
Wire return: PersonalNotesUpdateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_notes_delete_v1¶
notes_delete; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
| confirmation_id | object | no | Typed confirmation_id; see the executable input schema. |
Wire return: PersonalNotesDeleteV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_notes_read_v1¶
notes_read; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
Wire return: PersonalNotesReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_notes_search_v1¶
notes_search; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| page_size | integer | no | Typed page_size; see the executable input schema. |
| cursor | object | no | Typed cursor; see the executable input schema. |
| keyword | string | no | Typed keyword; see the executable input schema. |
Wire return: PersonalNotesSearchV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_bookmarks_create_v1¶
bookmarks_create; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| reference | object | yes | Typed reference; see the executable input schema. |
| title | string | yes | Typed title; see the executable input schema. |
| description | string | no | Typed description; see the executable input schema. |
Wire return: PersonalBookmarksCreateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_bookmarks_update_v1¶
bookmarks_update; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| reference | object | yes | Typed reference; see the executable input schema. |
| title | string | yes | Typed title; see the executable input schema. |
| description | string | no | Typed description; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
Wire return: PersonalBookmarksUpdateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_bookmarks_delete_v1¶
bookmarks_delete; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
| confirmation_id | object | no | Typed confirmation_id; see the executable input schema. |
Wire return: PersonalBookmarksDeleteV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_bookmarks_read_v1¶
bookmarks_read; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
Wire return: PersonalBookmarksReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_bookmarks_list_v1¶
bookmarks_list; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| page_size | integer | no | Typed page_size; see the executable input schema. |
| cursor | object | no | Typed cursor; see the executable input schema. |
| keyword | string | no | Typed keyword; see the executable input schema. |
Wire return: PersonalBookmarksListV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_subscriptions_create_v1¶
subscriptions_create; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| spec | object | yes | Typed spec; see the executable input schema. |
Wire return: PersonalSubscriptionsCreateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_subscriptions_update_v1¶
subscriptions_update; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| spec | object | yes | Typed spec; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
Wire return: PersonalSubscriptionsUpdateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_subscriptions_pause_v1¶
subscriptions_pause; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
| confirmation_id | object | no | Typed confirmation_id; see the executable input schema. |
Wire return: PersonalSubscriptionsPauseV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_subscriptions_resume_v1¶
subscriptions_resume; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
| confirmation_id | object | no | Typed confirmation_id; see the executable input schema. |
Wire return: PersonalSubscriptionsResumeV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_subscriptions_delete_v1¶
subscriptions_delete; typed private_object; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
| confirmation_id | object | no | Typed confirmation_id; see the executable input schema. |
Wire return: PersonalSubscriptionsDeleteV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_subscriptions_read_v1¶
subscriptions_read; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
Wire return: PersonalSubscriptionsReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_subscriptions_list_v1¶
subscriptions_list; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
Wire return: PersonalSubscriptionsListV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_notifications_read_v1¶
notifications_read; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| page_size | integer | no | Typed page_size; see the executable input schema. |
| cursor | object | no | Typed cursor; see the executable input schema. |
| keyword | string | no | Typed keyword; see the executable input schema. |
| subscription_id | object | no | Typed subscription_id; see the executable input schema. |
| unread_only | boolean | no | Typed unread_only; see the executable input schema. |
| order | object | no | Typed order; see the executable input schema. |
| delivered_from | object | no | Typed delivered_from; see the executable input schema. |
| delivered_before | object | no | Typed delivered_before; see the executable input schema. |
Wire return: PersonalNotificationsReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_notifications_collect_v1¶
notifications_collect; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| page_size | integer | no | Typed page_size; see the executable input schema. |
| cursor | object | no | Typed cursor; see the executable input schema. |
| keyword | string | no | Typed keyword; see the executable input schema. |
| subscription_id | object | no | Typed subscription_id; see the executable input schema. |
| unread_only | boolean | no | Typed unread_only; see the executable input schema. |
| order | object | no | Typed order; see the executable input schema. |
| delivered_from | object | no | Typed delivered_from; see the executable input schema. |
| delivered_before | object | no | Typed delivered_before; see the executable input schema. |
Wire return: PersonalNotificationsCollectV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_notifications_detail_v1¶
notifications_detail; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
Wire return: PersonalNotificationsDetailV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_notifications_mark_read_v1¶
notifications_mark_read; typed private_object; explicit owner/domain consent. Idempotency: set_read_once. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
Wire return: PersonalNotificationsMarkReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_imports_preview_v1¶
imports_preview; typed private_object; explicit owner/domain consent. Idempotency: bounded_preview_new_identifier. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| csv_text | string | yes | Typed csv_text; see the executable input schema. |
Wire return: PersonalImportsPreviewV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_imports_read_v1¶
imports_read; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
Wire return: PersonalImportsReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_imports_commit_v1¶
imports_commit; typed private_object; explicit owner/domain consent. Idempotency: preview_selection_and_confirmation. Confirmation: bound_owner_approval_required. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| preview_id | string | yes | Typed preview_id; see the executable input schema. |
| selected | object | yes | Typed selected; see the executable input schema. |
| replace_rows | object | no | Typed replace_rows; see the executable input schema. |
| confirmation_id | string | yes | Typed confirmation_id; see the executable input schema. |
Wire return: PersonalImportsCommitV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_income_summary_v1¶
income_summary; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| period | object | yes | Typed period; see the executable input schema. |
Wire return: PersonalIncomeSummaryV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_valuations_read_v1¶
valuations_read; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
| mode | object | no | Typed mode; see the executable input schema. |
| valuation_at | object | no | Typed valuation_at; see the executable input schema. |
Wire return: PersonalValuationsReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_exports_create_v1¶
exports_create; typed task; explicit owner/domain consent. Idempotency: owner_operation_request_key. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| idempotency_key | string | yes | Typed idempotency_key; see the executable input schema. |
| domains | object | yes | Typed domains; see the executable input schema. |
Wire return: PersonalExportsCreateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_exports_status_v1¶
exports_status; typed task; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
Wire return: PersonalExportsStatusV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_exports_download_v1¶
exports_download; typed task; explicit owner/domain consent. Idempotency: bounded_expiring_reference. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| object_id | string | yes | Typed object_id; see the executable input schema. |
Wire return: PersonalExportsDownloadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_preferences_read_v1¶
preferences_read; typed management; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
Wire return: PersonalPreferencesReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_preferences_update_v1¶
preferences_update; typed management; explicit owner/domain consent. Idempotency: expected_account_version. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| preferences | object | yes | Typed preferences; see the executable input schema. |
| expected_version | integer | yes | Typed expected_version; see the executable input schema. |
Wire return: PersonalPreferencesUpdateV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_account_read_v1¶
account_read; typed management; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
Wire return: PersonalAccountReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_account_guide_v1¶
account_guide; typed management; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
Wire return: PersonalAccountGuideV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_sessions_read_v1¶
sessions_read; typed management; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
Wire return: PersonalSessionsReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_usage_read_v1¶
usage_read; typed usage; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| hours | integer | no | Typed hours; see the executable input schema. |
Wire return: PersonalUsageReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_search_read_v1¶
search_read; typed private_object; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| query | object | yes | Typed query; see the executable input schema. |
| cursor | object | no | Typed cursor; see the executable input schema. |
Wire return: PersonalSearchReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_company_detail_read_v1¶
company_detail_read; typed financial_composite; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| subject | object | yes | Typed subject; see the executable input schema. |
| as_of | object | yes | Typed as_of; see the executable input schema. |
Wire return: PersonalCompanyDetailReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_etf_detail_read_v1¶
etf_detail_read; typed financial_composite; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| subject | object | yes | Typed subject; see the executable input schema. |
| as_of | object | yes | Typed as_of; see the executable input schema. |
Wire return: PersonalEtfDetailReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_comparison_read_v1¶
comparison_read; typed financial_composite; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| subjects | object | yes | Typed subjects; see the executable input schema. |
| metrics | object | yes | Typed metrics; see the executable input schema. |
| as_of | object | yes | Typed as_of; see the executable input schema. |
| sort_metric | object | no | Typed sort_metric; see the executable input schema. |
| descending | boolean | no | Typed descending; see the executable input schema. |
Wire return: PersonalComparisonReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_filing_workflow_read_v1¶
filing_workflow_read; typed financial_composite; explicit owner/domain consent. Idempotency: safe_read. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| question | object | yes | Typed question; see the executable input schema. |
Wire return: PersonalFilingWorkflowReadV1Result.
Default OAuth access: false.
- cli:
$request→request_file.
personal_confirmation_prepare_v1¶
confirmation_prepare; typed confirmation; explicit owner/domain consent. Idempotency: bounded_confirmation_new_identifier. Confirmation: none. Account revocation, deletion and identity changes require the trusted account flow.
| Parameter | Type | Required | Description |
| --- | --- | --- | --- | --- |
| request_id | string | yes | Typed request_id; see the executable input schema. |
| target_tool | string | yes | Typed target_tool; see the executable input schema. |
| arguments | object | yes | Typed arguments; see the executable input schema. |
Wire return: PersonalConfirmationPrepareV1Result.
Default OAuth access: false.
- cli:
$request→request_file.