finance

Get quarterly or annual fundamentals for a public company

Returns reported fundamentals for one US-listed company from its SEC filings: revenue, cost of goods sold, gross profit, inventory, the change in inventory since the previous period, and accounts payable, newest period first. Each row carries period_end, the fiscal year and period, the SEC form and the original filing date. The fiscal year and period come from the company's own fiscal calendar: a quarter belongs to the fiscal year that contains it, and a year carries the number the company gave it in that year's annual report. No two rows share a fiscal year and period, and a period that cannot be placed has null labels. Quarterly rows use the quarter's own figures, including 16-week first quarters; the fourth quarter is rarely filed on its own, so it is computed as the fiscal year minus the first nine months, with every figure taken from the same filings so a later restatement of the year is not pushed into Q4, and listed in the row's derived_fields. concepts_used names the US GAAP concept that fed each field, because companies tag the same line differently: a retailer may report cost of goods sold under one concept and a software company cost of revenue under another, some companies report payables only as one accounts payable and accrued liabilities line, and a LIFO retailer that reports FIFO cost and the LIFO reserve as separate lines gets inventory as their difference, listed as computed. Gross profit is the company's reported figure when it equals revenue minus cost of goods sold, otherwise that difference. A cost line the company tags in quarterly reports but never in its annual report is not used as cost of goods sold, so cost of goods sold and gross profit stay null instead of showing a misleading margin. A figure the company does not report is null, never 0: a company with no inventory line returns null inventory. Values are USD, as filed; a restated figure replaces the original. Covers companies that file US GAAP statements with the SEC. Foreign filers on IFRS, companies whose latest US GAAP period ended more than two years ago, and unlisted companies return not found, and the credits are refunded.

get/finance/fundamentals

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/finance/fundamentals
  • Auth: API key in header x-api-key

Query parameters

keywordstring required

Company ticker, case-insensitive. A bare symbol ('TGT') or the 'TICKER:EXCHANGE' form; the exchange suffix is ignored. Share classes work as 'BRK.B' or 'BRK-B'.

period'quarterly' | 'annual'

Reporting period: quarterly or annual. Defaults to quarterly.

limitinteger

Number of most recent periods to return, a whole number from 1 to 40. Defaults to 8. A value outside that range is rejected with a 400 and the credits are refunded.

Headers

Cache-Controlstring

Send no-cache to bypass the response cache and force a live fetch. Billed at the normal endpoint cost; the fresh result is written back to cache for the next caller. Only the no-cache directive triggers this. See the Response Schema guide for details.

Idempotency-Keystring

Optional UUID that makes the request safely retriable. The key is reserved atomically per account before billing. A concurrent retry receives 409 IDEMPOTENCY_IN_PROGRESS with a Retry-After of 1 second while the original is young, growing to a quarter of the time it has been running (at most 30); a crashed reservation expires after 5 minutes. A replay keeps the cached payload immutable except for billing metadata: credits_used becomes 0, idempotent_replay becomes true, and credits_remaining is refreshed to the current balance. A known current balance appears in both the body and X-Credits-Remaining header; no balance row resolves to 0. On a transient lookup failure, body credits_remaining is null and X-Credits-Remaining is omitted. Completed outcomes expire after 24 hours. If the claim store is unavailable, the request fails closed before billing. GET endpoints do not combine idempotent replay with Server-Sent Events: use Accept: application/json when sending this header. The unsupported key-plus-SSE combination is rejected before billing.

Response

Successful response

successboolean required

Whether the request succeeded

platformstring required

Platform name

endpointstring required

API endpoint path

credits_usedinteger required

Number of credits consumed

credits_remaininginteger nullable required

Current account balance, or null when this response could not establish one. Free cache hits always return null because they do not establish an authoritative post-request balance. An idempotency replay also returns null when its current-balance lookup fails. It is never a fabricated zero, so a zero here means the account really is empty. The authoritative reading is the one on a billed response, which comes straight from the deduction.

request_idstring required

Unique request identifier for support

cachedboolean required

Whether the response was served from cache

idempotent_replayboolean

True only when this response is an idempotency replay

Example response

{
  "success": true,
  "platform": "finance",
  "endpoint": "/v1/finance/fundamentals",
  "credits_used": 1,
  "credits_remaining": 4999,
  "request_id": "req-abc123",
  "idempotent_replay": true,
  "meta": {
    "hint": {
      "code": "search_multi",
      "message": "You searched \"matcha\" on 3 platforms one call at a time; /v1/search/multi returns each platform's own search rows in one call at the same price per platform, and a platform with no rows is not charged.",
      "method": "GET",
      "path": "/v1/search/multi?query=matcha&platforms=instagram,tiktok,youtube"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.