Skip to content
StockAlloy Docs

Quickstart

0. Try it with no key at all

Section titled “0. Try it with no key at all”

The sandbox needs no signup — 5 requests per day per IP:

Terminal window
curl -s "https://api.stockalloy.com/api/sandbox/facts?ticker=DECK&metric=revenue"
Terminal window
curl -s "https://api.stockalloy.com/api/sandbox/search?q=rocket+lab+backlog"

Every sandbox response includes an X-Sandbox-Remaining header with your remaining requests for the day. When it hits zero you’ll get a 429 with error code SANDBOX_LIMIT.

1. Get a free API key (2 minutes)

Section titled “1. Get a free API key (2 minutes)”
  1. Go to stockalloy.com/developer and sign up.
  2. Click Start free — the Free plan is $0, 500 calls/month, no credit card.
  3. Create an API key. It’s shown once — copy it somewhere safe.

Export it in your shell:

Terminal window
export STOCKALLOY_API_KEY="sa_b2b_..."

2. Your first call

Section titled “2. Your first call”

All authenticated endpoints are POST with a JSON body and your key in the X-API-Key header. Fetch the latest verified fact for every one of Deckers’ consolidated series:

Terminal window
curl -s https://api.stockalloy.com/api/b2b/facts/latest \
  -H "Content-Type: application/json" \
  -H "X-API-Key: $STOCKALLOY_API_KEY" \
  -d '{"ticker": "DECK"}'

Response (truncated):

{
  "scope": "company",
  "ticker": "DECK",
  "cik": "0001011570",
  "metric_id": null,
  "count": 142,
  "rows": [
    {
      "series_key": "91b2c4d6e8…",
      "metric_id": "us-gaap#RevenueFromContractWithCustomerExcludingAssessedTax",
      "metric_label": "Revenue",
      "period_key": "duration:2023-04-01..2024-03-31",
      "period_end": "2024-03-31",
      "unit_signature": "monetary:USD",
      "value_num": "4287763000",
      "source_accession": "0001011570-24-000039",
      "source_form_type": "10-K",
      "source_filed_at": "2024-05-24",
      "evidence_url": "https://stockalloy.com/api/evidence/01HYX…/open?cik=0001011570&accession=0001011570-24-000039",
      "is_consolidated": true
    }
  ]
}

3. Click the proof

Section titled “3. Click the proof”

Open any evidence_url in a browser. It redirects to the actual SEC filing with the exact figure highlighted. That link is safe to surface directly in your product — it’s how your users audit the numbers you show them.

4. Go deeper

Section titled “4. Go deeper”