{"openapi":"3.1.0","info":{"title":"XFINLAB Intelligence (BYOK) API","version":"0.1.0","description":"XFINLAB Intelligence (BYOK) lets an AI assistant read your own XFINLAB Intelligence data through the XFINLAB Intelligence API with a key you supply (XFINLAB Intelligence API key (xfl_...)). Read-only: 12 tools (get_fundamentals, get_fundamentals_as_of, get_insider_trades, get_short_interest, get_vix_term_structure, get_bank_health, get_agriculture_prices, get_energy_fundamentals,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-xfinlab.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-xfinlab/docs"},"termsOfService":"https://connectorbay.com/byok-xfinlab/terms"},"servers":[{"url":"https://byok-xfinlab.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-xfinlab/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_fundamentals":{"post":{"operationId":"get_fundamentals","summary":"Get a US-listed company's latest annual (10-K) SEC XBRL facts: revenue, net income, diluted EPS, total assets, total lia","description":"Get a US-listed company's latest annual (10-K) SEC XBRL facts: revenue, net income, diluted EPS, total assets, total liabilities and operating cash flow. A concept is missing when the company never reported it. Cached for 24 hours. Use for \"What were Apple's latest annual revenue and net income\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ticker":{"description":"US ticker symbol, for example AAPL.","maxLength":12,"title":"Ticker","type":"string"}},"required":["ticker"],"title":"get_fundamentalsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_fundamentals_as_of":{"post":{"operationId":"get_fundamentals_as_of","summary":"Get the annual 10-K figures that were public for a company on a past date (filing date plus two business days), so backt","description":"Get the annual 10-K figures that were public for a company on a past date (filing date plus two business days), so backtests and past-date questions avoid look-ahead bias. Annual figures from 2009 on; call get_fundamentals for the ticker once first if the answer says NO_POINT_IN_TIME_DATA. Use for \"What annual revenue of Microsoft was known on 2021-03-31\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ticker":{"description":"US ticker symbol, for example MSFT.","maxLength":12,"title":"Ticker","type":"string"},"as_of_date":{"description":"The date to look back from (YYYY-MM-DD, 2009-01-01 or later).","maxLength":10,"title":"As Of Date","type":"string"}},"required":["ticker","as_of_date"],"title":"get_fundamentals_as_ofArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_insider_trades":{"post":{"operationId":"get_insider_trades","summary":"Get recent SEC Form 4 open-market insider transactions for a ticker (insider name and role, date, shares, price) with a ","description":"Get recent SEC Form 4 open-market insider transactions for a ticker (insider name and role, date, shares, price) with a buy and sell summary. Direct stock transactions only; cached for 24 hours. Use for \"Have Tesla insiders been buying or selling recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ticker":{"description":"US ticker symbol, for example TSLA.","maxLength":12,"title":"Ticker","type":"string"}},"required":["ticker"],"title":"get_insider_tradesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_short_interest":{"post":{"operationId":"get_short_interest","summary":"Get FINRA's latest bi-weekly short interest for a ticker: current and previous short shares, average daily volume, days ","description":"Get FINRA's latest bi-weekly short interest for a ticker: current and previous short shares, average daily volume, days to cover and the change. Use for \"How much of GameStop is currently sold short\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ticker":{"description":"US ticker symbol, for example GME.","maxLength":12,"title":"Ticker","type":"string"}},"required":["ticker"],"title":"get_short_interestArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_vix_term_structure":{"post":{"operationId":"get_vix_term_structure","summary":"Get the CBOE VIX9D, VIX, VIX3M and VIX6M closes with a contango, backwardation or flat reading; one market-wide snapshot","description":"Get the CBOE VIX9D, VIX, VIX3M and VIX6M closes with a contango, backwardation or flat reading; one market-wide snapshot. Use for \"Is the VIX curve in backwardation right now\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_vix_term_structureArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_bank_health":{"post":{"operationId":"get_bank_health","summary":"Get FDIC Call Report health of a major US bank's lead bank subsidiary: assets, equity, net income, ROA and ROE. Covers J","description":"Get FDIC Call Report health of a major US bank's lead bank subsidiary: assets, equity, net income, ROA and ROE. Covers JPM, BAC, WFC, C, USB, PNC and TFC. Use for \"How healthy is JPMorgan's lead bank according to FDIC data\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ticker":{"description":"Bank holding company ticker: JPM, BAC, WFC, C, USB, PNC or TFC.","maxLength":12,"title":"Ticker","type":"string"}},"required":["ticker"],"title":"get_bank_healthArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_agriculture_prices":{"post":{"operationId":"get_agriculture_prices","summary":"Get USDA prices received by farmers for corn, wheat or soybeans through the matching ticker (CORN, WEAT, SOYB); other ti","description":"Get USDA prices received by farmers for corn, wheat or soybeans through the matching ticker (CORN, WEAT, SOYB); other tickers return no data. Use for \"What price are farmers receiving for corn\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ticker":{"description":"Commodity ETF ticker: CORN, WEAT or SOYB.","maxLength":12,"title":"Ticker","type":"string"}},"required":["ticker"],"title":"get_agriculture_pricesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_energy_fundamentals":{"post":{"operationId":"get_energy_fundamentals","summary":"Get EIA physical-market context for USO (WTI crude spot) or UNG (Henry Hub gas spot and Lower-48 storage); other tickers","description":"Get EIA physical-market context for USO (WTI crude spot) or UNG (Henry Hub gas spot and Lower-48 storage); other tickers return no data. Use for \"What is the WTI crude spot price and where is natural gas storage\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ticker":{"description":"Energy ETF ticker: USO or UNG.","maxLength":12,"title":"Ticker","type":"string"}},"required":["ticker"],"title":"get_energy_fundamentalsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_exchange_comparison":{"post":{"operationId":"get_exchange_comparison","summary":"Compare a crypto ticker's live 24-hour price, change, range and volume on Binance and Coinbase side by side (tracked cry","description":"Compare a crypto ticker's live 24-hour price, change, range and volume on Binance and Coinbase side by side (tracked crypto tickers only). Use for \"How does BTC trade on Binance versus Coinbase\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ticker":{"description":"Crypto ticker such as BTC or ETH.","maxLength":12,"title":"Ticker","type":"string"}},"required":["ticker"],"title":"get_exchange_comparisonArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_real_estate_context":{"post":{"operationId":"get_real_estate_context","summary":"Get FRED housing context (30-year mortgage rate, home price index, housing starts, existing home sales) for housing-link","description":"Get FRED housing context (30-year mortgage rate, home price index, housing starts, existing home sales) for housing-linked tickers such as DHI, LEN, O, PLD or VNQ; other tickers return no data. Use for \"What is the 30-year mortgage rate relevant to homebuilder DHI\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ticker":{"description":"Housing-linked ticker, for example DHI, LEN, PHM, O, SPG, PLD, VNQ or XHB.","maxLength":12,"title":"Ticker","type":"string"}},"required":["ticker"],"title":"get_real_estate_contextArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_technical_analysis":{"post":{"operationId":"get_technical_analysis","summary":"Get computed technical analysis for a ticker: trend, RSI, MACD, support and resistance, indicators, confluence score and","description":"Get computed technical analysis for a ticker: trend, RSI, MACD, support and resistance, indicators, confluence score and direction, and market structure. Raw price bars are not included. Use for \"What does the technical picture for NVDA look like\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ticker":{"description":"Ticker symbol, for example NVDA.","maxLength":12,"title":"Ticker","type":"string"}},"required":["ticker"],"title":"get_technical_analysisArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_opportunity_radar":{"post":{"operationId":"get_opportunity_radar","summary":"Get a market-wide snapshot of US macro indicators (fed funds rate, unemployment, yield curve, jobless claims) and improv","description":"Get a market-wide snapshot of US macro indicators (fed funds rate, unemployment, yield curve, jobless claims) and improving or worsening readings for real estate, supply chain, consumer demand, energy and agriculture. Use for \"Which US industries look to be improving or worsening on macro data\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_opportunity_radarArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}