API Documentation

Authentication & API Keys

Security & Auth

Authentication Architecture & Credentials

All programmatic requests to GridMap market datasets require explicit header-based authentication via Developer API Key (X-API-Key: gm_live_...).

HTTP Header SpecMandatory
X-API-Key: gm_live_abcdef1234567890
API Key Provisioning
ONE-TIME REVEAL

API keys are revealed only once upon creation in your Dashboard. For security, only the hash is preserved by our backend.

Device Storage: Save your key in an environment variable (GRIDMAP_API_KEY) on your local machine, server, or cloud function.
Production API Key Header
STANDARD

For backend microservices, Python scrapers, trading algorithms, and automated cron pipelines, attach your key to the x-api-key HTTP header.

Unified Response: Requests authenticated via x-api-key return the exact same standardized envelope with telemetry data and real-time remaining credit balance.
Quota Accounting: 1 Market Query = 1 Credit
Deducted per Request via API Key

Every market data query executed using your x-api-key header deducts credits from your active plan balance identically:

1 Market Query
Deducts 1 Plan Credit
Meta Endpoints
Free (0 Credits / Public)
Rate Limits
Refer to Plan Limits below
Security Notice: Never Use Browser Session Tokens in Production Code

Do not extract session tokens from browser localStorage for external automation. Browser tokens expire rapidly and are bound to web session lifecycles. Always provision a dedicated gm_live_... API key and inject it via environment variables (GRIDMAP_API_KEY).

Manage and reveal your developer API keys in the dashboard atgridmap.in/dashboard
Open Dashboard