Quickstart

Get a scored exchange filing in two minutes.

1. Create a key

Sign in, open API Keys, and create one. The key is shown once — we store only a SHA-256 hash of it, so it cannot be recovered. If you lose it, revoke it and create another.

Keys look like this:

ck_live_7Kq2nR8vW4xY6zA1bC3dE5fG9hJ0kL2mN4pQ6rS8tU

2. Make a request

curl -sS https://api.cruxal.in/v1/filings \
  -H "Authorization: Bearer $CRUXAL_API_KEY" \
  -G --data-urlencode "impact_min=7" \
     --data-urlencode "limit=2"

3. Read the response

{
  "data": [
    {
      "id": "7701f640-d532-4ba0-979c-1a298a186f1e",
      "isin": "INE549D01012",
      "ticker": "WSFX",
      "company_name": "WSFx Global Pay Ltd",
      "filed_at": "2026-08-16T19:43:37+05:30",
      "scored_at": "2026-08-16T19:44:02+05:30",
      "exchange_headline": "Investor Presentation for the Quarter ended June 30, 2026.",
      "category": "Company Update",
      "subcategory": "Investor Presentation",
      "source_pdf": "https://www.bseindia.com/xml-data/corpfiling/AttachLive/2e21....pdf",
      "headline": "WSFx Global Pay posts 24% revenue growth in Q1 FY27",
      "summary": "The presentation shows revenue of ...",
      "sentiment": "positive",
      "impact_score": 7.4,
      "tags": ["earnings_disclosure", "investor_presentation"]
    }
  ],
  "next_cursor": "eyJ2IjoxLCJ0IjoxNzU1Mzg4ODAwMTIzNDU2LCJpIjo4ODIxMzQ1LCJmIjoiYTNmOWMxZDIifQ",
  "has_more": true
}

That is the whole product in one object: the exchange's own document, plus our reading of it.

What to know before you build

Keys are server-side credentials. There is no CORS policy that permits browser calls, on purpose. A key in front-end JavaScript is a key that has been published.

Every timestamp is IST and says so. filed_at and scored_at always carry an explicit +05:30. You never have to guess a timezone.

ISIN is the identifier, not ticker. Around 110 tickers map to more than one ISIN, so ?ticker= can legitimately return several securities. Use ?isin= when you mean one company.

impact_score is a model output. It runs 0–10, where above 7 is materially market-moving. It is an estimate, not a guarantee, and it is not investment advice.

Next

• Authentication — live versus test keys, and rotation
• Pagination — following next_cursor correctly
• Limits and caveats — read this before you build anything that depends on coverage