companies.financials

Request

Body of POST /v1/capabilities/companies.financials/execute, JSON, validated against the CompaniesFinancialsRequest component of the public OpenAPI document. Defaults are applied server-side, so an omitted optional field behaves exactly as its default.

• Unknown keys are rejected with 400 invalid_request.

Rules the schema cannot express

Checked after schema validation; violations return 400 invalid_request with a plain message.

• A ticker must identify exactly one SEC filer; otherwise use the CIK.
• filed_from and filed_to must be valid ISO dates and filed_from must not follow filed_to.
• Fact views (financials, revenue_breakdown) require accession.

Examples

curl -s -X POST https://api.powerups-ai.store/v1/capabilities/companies.financials/execute \
  -H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
  -d '{"company":{"ticker":"NVDA"},"forms":["10-K"],"num":1}'

Result record

Every item in results[] carries record_id and title (contract, always present) and usually url and snippet. The keys below are the documented tier: produced deterministically by this capability, omitted when the source has no value, checked against recorded source fixtures in our test suite, and published as the CompaniesFinancialsRecord component (all optional, extra keys allowed) so generated clients type them. The wire schema itself still validates only the base keys. See stability tiers.

Caveats

• financials and revenue_breakdown details may include continuation: { capability, body }, a typed next request for the paginated fact view.

Follow-ups

• Paging: Whole result set held in the session; more is served locally and costs nothing. Send { "search_id": "…", "action": "more" } while has_more is true; tolerate an empty page and stop after a bounded number of pages.
• Update: Re-run with changed parameters (merged into the stored query); page state resets, search_id stays. Params accept any subset of the request fields (CompaniesFinancialsUpdateParams).
• Record actions:
  • details: Filing identity and authoritative source links.
  • financials: Financial facts from this filing, with exact units, periods and a continuation request if needed.
  • revenue_breakdown: Revenue facts with their actual filing dimensions; preserves distinct business, geographic and product axes.
• Detail behaviour: Free provider lookup on first call; repeats are cached. details, financials and revenue_breakdown read SEC EDGAR directly at no charge; repeated calls are cached.

curl -s -X POST https://api.powerups-ai.store/v1/follow-up \
  -H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
  -d '{"record_id":"rec_…","action":"details"}'

Other record detail objects are provider-shaped: documented by observation, not by schema. Full follow-up semantics: follow-up.

Typed client

With types generated from the public document (see types, client and samples) the call is path-keyed and the body is checked at compile time:

const { data, error } = await client.POST("/v1/capabilities/companies.financials/execute", {
  body: {
    "company": {
      "ticker": "NVDA"
    },
    "forms": [
      "10-K"
    ],
    "num": 1
  },
});
if (error) throw new Error(`${error.error.code}: ${error.error.message}`);
for (const record of data.results) console.log(record.record_id, record.title);