← Personal AreaEverything you need to use your personal API key with FederGEX NinjaTrader 8 indicators and custom analytical tools.
Your personal FederGEX API key is available in the Personal Area with an Elite entitlement. It connects the official FederGEX NinjaTrader 8 options indicators and your own analytical tools to FederGEX data.
Download the latest official package from the Elite channel. In NinjaTrader 8, open Tools → Import → NinjaScript Add-On…, select the downloaded package and restart if prompted. Paste your personal key into the API key field in the FederGEX indicator settings, following the package configuration guide.
Authenticate requests from your personal scripts, custom indicators, applications, dashboards or research tools. Use the returned snapshot to display and analyse the supported options data.
An active internet connection and valid Elite entitlement are required. Keep the key private and use it only for your own account.
Your personal key connects the official FederGEX options indicators to the service. Follow these steps and the configuration notes supplied with each release.
Use your own key only. Multiple indicators and custom applications using that key share its API request limits. Consult each package’s requirements and setup guide before installation.
The API provides options analytics for these six instruments. Options data is provided during US regular trading hours (RTH). Always check the status and timestamps before treating a snapshot as current.
ES, NQ, GC and CL futures data are not distributed through this API.
Send a GET request to the snapshot endpoint and provide your personal key in the x-api-key HTTP header. Replace SPX with any supported symbol.
https://app.federgex.comGET /api/v1/snapshot?channel=SPXx-api-key: YOUR_API_KEYThe examples below use a placeholder. Do not put your actual key in a public page, shared repository or screenshot.
curl -H "x-api-key: YOUR_API_KEY" \
"https://app.federgex.com/api/v1/snapshot?channel=SPX"$key = "YOUR_API_KEY"
curl.exe -s `
-H "x-api-key: $key" `
"https://app.federgex.com/api/v1/snapshot?channel=SPX"A snapshot can contain the current analytical state of the selected instrument. Use the fields returned by the live endpoint; the groups below describe the available information.
| Data group | What it can contain | How you can use it |
|---|---|---|
| Market & gamma | Spot, Zero Gamma, Major Positive / Negative Gamma, Net GEX by Volume and Open Interest | Display reference levels and options context beside your price chart. |
| Strike structure | Strike prices, gamma by Volume and Open Interest per strike | Create personal gamma profiles and compare exposure across strikes. |
| Flow | Price levels, net values, positive / negative maxima, add/remove activity and pulse information | Inspect the Flow information returned for each level. |
| Build | Price levels, net values, positive / negative maxima, add/remove activity and pulse information | Inspect Build information and compare it with your other analyses. |
| Freshness | Status, timestamps, fetch time and snapshot age | Check whether the returned data is sufficiently recent for your tool. |
This illustrative example shows selected fields only. Flow, Build, freshness fields and additional strikes are omitted; consult the actual response for their structure and values.
{
"ticker": "SPX",
"status": "live",
"timestamp": 1787242363129,
"spot": 7677.14,
"zeroGamma": 7685.51,
"majorPosVol": 7700,
"majorNegVol": 7670,
"netGexVol": -89252.353,
"netGexOi": -30878.939,
"strikes": [
{
"spx": 7700,
"gammaVol": 38233.11,
"gammaOi": -3234.61
}
]
}FederGEX caches data and continuously refreshes it through its infrastructure. Sending more requests does not necessarily produce newer market data.
Start with one request every 3–5 seconds and adjust to your needs. Count requests across all indicators and custom tools using the same key; tools on the same public IP also share the IP limit.
If you receive HTTP 429 — Too Many Requests, pause before retrying. Respect a Retry-After header if present and increase the interval between requests.
The key is personal, linked to your FederGEX account and intended exclusively for the account holder. Abnormal or abusive usage may result in temporary limitations or suspension of API access.