Building with the API? Open the developer docs

Finmagine API & MCP — free tier to test • Pro/Max for full access • REST + MCP

Open the Docs →

← API & Agent Integration Hub ← All Feature Guides

Published: July 29, 2026 | 7 min read | Developer Guide | API & Agent Integration Series

Multimedia Learning Hub

Master the API Explorer through a complete learning overview and interactive flashcards

What You Will Master

The three Wave 1 guides covered discovery, pricing, and the contract. This guide covers the fastest way to actually try any of it — the Interactive API Explorer, a page that lets you fire a real request against any of Finmagine's 86 operations directly from your browser, with no code, no Postman collection to import, and no local setup.

What This Guide Covers:

What Zero-Setup Actually Means — what runs where, and why nothing needs installing
Two Markets, Two Layouts — India's pure-REST view vs. the US tab's REST + MCP tool list
Anatomy of a Request — selecting an endpoint, editing parameters, watching the URL build live
Reading a Response — status badges, timing, and syntax-highlighted JSON
Run All — Batch-Testing Everything at Once
The Hidden LLM-Powered Endpoints Toggle — quotas, provider picking, and the confirm-to-arm safety gate
Where Your API Key Actually Goes — and why it's safe to paste it in

Who This Is For:

Anyone evaluating the API before writing a single line of integration code — see a real response in under a minute
Developers debugging a request — isolate a parameter issue in the Explorer before suspecting your own code
Agent builders exploring what's available — click through all 86 operations to understand response shapes firsthand

Test Your Knowledge

Click any card to reveal the answer. Use the search box to find a specific topic.

What "Zero-Setup" Actually Means Here

Open developer/api-explorer.php, sign in if you haven't already, paste an API key into the key bar at the top, and you're ready — there's no SDK to install, no Postman collection to import, no local server to run.

Traditional path	API Explorer path
Read the docs, write request code, run it locally, debug	Click an endpoint, click Run, read the response
Install an HTTP client (curl, Postman, Insomnia)	Nothing to install — it's a page in your browser
Manually construct query strings and headers	Parameters are form fields; the request URL builds itself as you type
Guess at what a response looks like from prose docs	See the actual, live JSON response for that exact call

You do need to be logged in — that's the one exception to "zero setup." Unlike the docs and reference pages, which are public, the Explorer requires a Finmagine account, because it needs somewhere to attach the key bar to. A Free-tier API key works perfectly well here — you don't need a paid subscription to try the tool.

STEP 1

Two Markets, Two Layouts

A tab bar at the top switches the entire page between two views:

🇮🇳 Indian Markets — REST only

The India tab lists every Indian-market REST operation, grouped by category (Core, Company Intel, Market Intel, AI Content, Feeds), each with a colour-coded HTTP method badge and a tier badge (Free / Pro / Max) so you can see at a glance what a given key can call.

🇺🇸 US Markets — REST and MCP, side by side

The US tab is deliberately different: it lists REST operations and the equivalent MCP tools as separate, individually selectable entries — grouped "— REST" and "— MCP" — so you can compare the two calling conventions for the same underlying data directly. Selecting an MCP tool shows a JSON-RPC 2.0 payload preview instead of a URL, and the Run button POSTs it live to /api/mcp.php exactly the way Claude or any other MCP client would.

This is the fastest way to understand REST vs. MCP without reading a spec. Pick any US operation that has both — say, momentum or ratios — run the REST version, then run the MCP version, and compare the request shapes and response envelopes side by side in the same session.

STEP 2

Anatomy of a Request

Clicking any endpoint in the sidebar opens a request panel with:

Pre-filled demo values for every parameter, so the first thing you try already works — you don't have to know a valid NSE symbol before you can see a real response
Required vs. optional labels on each field, in red or grey respectively
A hint line under each input explaining what the parameter means
A live request URL preview that rebuilds itself on every keystroke — before you even click Run, you can see exactly what will be sent

// Example: editing the "symbol" parameter for get_momentum
// updates this preview live, character by character
https://finmagine.com/api/v1/company/momentum?symbol=HDFCBANK

Clicking Run fires a real HTTP request — not a simulated or cached example response. Whatever the live API returns right now for that exact call is what you'll see.

STEP 3

Reading a Response

Every response panel shows three things above the body:

Element	What it tells you
Status badge	Colour-coded — green for 2xx (success), orange for 4xx (client error, e.g. bad tier or missing param), red for 5xx (server error)
Response time	Milliseconds elapsed for that specific call, measured client-side
Request URL / tool name	The exact URL called (REST) or MCP tool name invoked, for copy-paste reference

Below that, the full JSON response is syntax-highlighted — keys in blue, strings in green, numbers in red, booleans in magenta, null in grey — the same visual convention most API tools use, making it easy to scan a large payload for the field you actually care about.

These are real calls against your real key. Every successful Run in the Explorer counts against your API key's daily and hourly rate limit exactly like a call from your own code would — see Understanding API & MCP Pricing Tiers for the actual numbers per tier. There's no separate "sandbox" quota.

BATCH MODE

Run All — Batch-Testing Everything at Once

The key bar includes a ⚡ Run All button (and a matching ⚡ Run All US on the US tab) that fires every REST endpoint in that market sequentially using their demo defaults, then shows a pass/fail summary row for each one — path, status, and a green or red indicator.

This is the single fastest way to sanity-check a fresh API key. Instead of clicking through dozens of endpoints individually to confirm your key works and your tier covers what you expect, Run All gives you the whole picture in one pass — including which operations correctly 403 because your current tier doesn't cover them.

Run All consumes real quota for every endpoint it calls. On Free tier's 10-requests-per-hour limit, running the full India batch will use a meaningful chunk of your hourly allowance in one click — worth knowing before you hit it more than once or twice per hour.

The Hidden LLM-Powered Endpoints Toggle

Five operations don't appear in the main endpoint list by default — they're gated behind a "Show LLM-powered endpoints" checkbox in the key bar, off by default. These are the operations that trigger an actual LLM call when you run them, rather than a straightforward database read:

Operation	What running it does
`start_committee`	Kicks off a real Investment Committee run — 5 requests per 24 hours per account, shared with the web UI
`start_preset`	Kicks off a real Strategy Lab Research Preset — 10 requests per 24 hours per account, shared with the web UI
`test_byo_key`	Makes a real ~15-second call to your own configured LLM provider to verify a BYO key works — rate-limited to 10 tests/hour, independent of your normal API limits
`screen_natural_language` / `us_screen_natural_language`	Parses a plain-English screen query using Finmagine's own free-tier LLM key (Groq/Gemini) — no cost or provider quota to you; Free-tier accounts get 20 calls/day

Why hidden by default? These five have real, meaningful consequences — spending shared daily quota, or in the case of test_byo_key, making a live call to a third-party provider using your own credentials. Keeping them behind an explicit toggle means you never trigger one by accident while casually browsing the endpoint list.

The confirm-to-arm safety gate

For the operations that spend a real provider's tokens or a shared quota, the Run button doesn't fire on the first click — it arms on the first click and shows what it's about to do (which provider, and for a preset run, the actual preset and goal that will be sent), then fires only on the second click. This two-step pattern exists specifically so a stray click never triggers real spend.

Where Your API Key Actually Goes

It's worth being precise about this, since pasting a secret key into a web page is exactly the kind of thing to be cautious about: the Explorer page runs entirely in your own browser and calls fetch() directly against https://finmagine.com/api/... — the same live endpoint your own code would call. There is no intermediate proxy server that sees your key; the request goes straight from your browser to the real API, precisely once, per call you make.

Storage: your key is kept in the browser's session storage first, falling back to localStorage if you explicitly want it remembered across visits — never sent to any Finmagine server except as the X-Api-Key header on the actual API call you triggered
The "Clear key" button removes it from local storage immediately
The key input is a password field — masked on screen by default, the same as any credential input

The Explorer is, functionally, just a JavaScript API client running in your tab. It has no special privileges and no server-side access to your key — it's making the exact same kind of request your own integration code would make, just with a UI wrapped around it.

What's Next

The Explorer is great for trying one operation in isolation. The next guide covers its counterpart for multi-step workflows:

The Agentic Workflow Explorer — run pre-built, multi-tool recipes end to end in the browser, including the async Investment Committee and Research Preset workflows with live polling and cancel support

See the API & Agent Integration hub for the full 12-guide roadmap.

Ready to Analyse Indian Stocks Like a Pro?

Finmagine gives you 30+ computed financial ratios, sector benchmarks, FII/DII flows, the Finmagine Score, and AI-powered analysis — all in one place.

Analyse a Stock → Create Free Account