Connect FederGEX options analytics to your own workflow.
Your personal API key is available in the FederGEX Personal Area. An active Elite entitlement and internet connection are required.
Open Personal Area ↗The same endpoint can be used by the official NinjaTrader 8 indicators or by proprietary user integrations, subject to the Elite API access policy.
{
"ticker": "SPX",
"status": "live",
"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 }
],
"flow": [
{ "price": 7700, "net": 51182351.85, "maxPos": 51184291.80, "maxNeg": 0 }
],
"build": [
{ "price": 7700, "net": 38222.23, "maxPos": 43496.03, "maxNeg": 0 }
],
"age_ms": 3694
}The same key can be used by official FederGEX NinjaTrader 8 indicators and your own personal indicators, applications or analytical tools.
Your key is linked to your account, intended exclusively for you and subject to usage limits. Never share it with third parties.
ES, NQ, GC and CL futures data are not distributed through the API.
Options analytics update during regular U.S. cash-market hours (RTH), normally 09:30–16:00 New York time on trading days, subject to holidays and early closes.
A snapshot can contain the following data. Inspect timestamps and freshness information before interpreting a response.
| Data group | Available information |
|---|---|
| Market & Gamma | Spot price, Zero Gamma, Major Positive Gamma, Major Negative Gamma, Net GEX by Volume and Open Interest. |
| Strike structure | Strike price, Gamma by Volume and Gamma by Open Interest for each available strike. |
| Flow | Price level, net value, maximum positive/negative values, add/remove activity and pulse information. |
| Build | Price level, net value, maximum positive/negative values, add/remove activity and pulse information. |
| Freshness | Timestamps, fetchedAt and age_ms information to help determine snapshot freshness. |
The response example above is simplified and uses illustrative values. Actual responses may contain multiple strike, Flow and Build levels.
https://app.federgex.com/api/v1/snapshot?channel=SPXBase URL: https://app.federgex.com. Replace SPX in the channel parameter with any supported symbol.
Authenticate using the HTTP header x-api-key with your personal FederGEX API key. Replace YOUR_API_KEY in the examples below locally.
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"FederGEX data is cached and continuously refreshed by the infrastructure. More frequent calls do not necessarily return newer market data.
All limits apply together. Requests from indicators and custom integrations using the same key share its allowance. Avoid unnecessary high-frequency polling: one request every few seconds is sufficient for most integrations, while respecting the total limits.
If you exceed the permitted rate, the API may temporarily return HTTP 429. Wait before sending additional requests.
Each license is personal. Indicators and integrations require an active internet connection and valid Elite entitlement. Abnormal or abusive usage may result in temporary limitation or suspension of API access.
For API activation, requests, installation or updates, contact official FederGEX support. Elite users can find the latest official indicator releases, fixes, installation guides, configuration instructions and API information in the reserved FederGEX Elite channel.