{"openapi":"3.1.0","info":{"title":"FinBrain (BYOK) API","version":"0.1.0","description":"FinBrain (BYOK) lets an AI assistant read your own FinBrain data through the FinBrain API with a key you supply (FinBrain API key). Read-only: 12 tools (list_tickers, list_markets, get_house_trades, get_senate_trades, get_lobbying_filings, get_government_contracts, get_patent_filings, get_news_sentiment, get_stock_news, get_analyst_ratings, get_put_call_ratio, get_insider_trading). The BYOK key...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-finbrain.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-finbrain/docs"},"termsOfService":"https://connectorbay.com/byok-finbrain/terms"},"servers":[{"url":"https://byok-finbrain.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-finbrain/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/list_tickers":{"post":{"operationId":"list_tickers","summary":"List the ticker symbols and company names FinBrain covers, optionally filtered by market (for example 'S&P 500' or 'NASD","description":"List the ticker symbols and company names FinBrain covers, optionally filtered by market (for example 'S&P 500' or 'NASDAQ'), region or forecast type. Use for \"Which tickers are in the S&P 500 list on FinBrain\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"type":{"anyOf":[{"enum":["daily","monthly"],"type":"string"},{"type":"null"}],"default":null,"description":"Forecast type the ticker must have: daily or monthly.","title":"Type"},"market":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Market name, for example 'S&P 500', 'NASDAQ' or 'Crypto Currencies' (see list_markets).","title":"Market"},"region":{"anyOf":[{"maxLength":30,"type":"string"},{"type":"null"}],"default":null,"description":"Region, for example 'US' or 'Global'.","title":"Region"},"limit":{"anyOf":[{"maximum":5000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"Maximum number of tickers to return.","title":"Limit"}},"title":"list_tickersArguments","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/list_markets":{"post":{"operationId":"list_markets","summary":"List the markets FinBrain covers (S&P 500, NASDAQ, DAX, Foreign Exchange, Crypto Currencies and more) with their regions","description":"List the markets FinBrain covers (S&P 500, NASDAQ, DAX, Foreign Exchange, Crypto Currencies and more) with their regions. Use for \"Which markets does FinBrain cover\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"list_marketsArguments","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_house_trades":{"post":{"operationId":"get_house_trades","summary":"Get US House member stock trades for a ticker from STOCK Act disclosures: member, transaction type, amount range, owner,","description":"Get US House member stock trades for a ticker from STOCK Act disclosures: member, transaction type, amount range, owner, trade date and disclosure date. Use for \"Which House members traded NVDA this year\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"symbol":{"description":"Stock ticker symbol, for example 'AAPL'.","maxLength":200,"title":"Symbol","type":"string"},"start_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Earliest date to include, YYYY-MM-DD.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Latest date to include, YYYY-MM-DD.","title":"End Date"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum number of rows to return (1 to 500).","title":"Limit"}},"required":["symbol"],"title":"get_house_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_senate_trades":{"post":{"operationId":"get_senate_trades","summary":"Get US Senate member stock trades for a ticker from STOCK Act disclosures: member, transaction type, amount range, owner","description":"Get US Senate member stock trades for a ticker from STOCK Act disclosures: member, transaction type, amount range, owner, trade date and disclosure date. Use for \"Which senators traded NVDA this year\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"symbol":{"description":"Stock ticker symbol, for example 'AAPL'.","maxLength":200,"title":"Symbol","type":"string"},"start_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Earliest date to include, YYYY-MM-DD.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Latest date to include, YYYY-MM-DD.","title":"End Date"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum number of rows to return (1 to 500).","title":"Limit"}},"required":["symbol"],"title":"get_senate_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_lobbying_filings":{"post":{"operationId":"get_lobbying_filings","summary":"Get federal lobbying disclosure filings for a company: quarter, lobbying firm, income and expenses, issue codes and gove","description":"Get federal lobbying disclosure filings for a company: quarter, lobbying firm, income and expenses, issue codes and government bodies engaged. Use for \"How much is Apple spending on lobbying and on which issues\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"symbol":{"description":"Stock ticker symbol, for example 'AAPL'.","maxLength":200,"title":"Symbol","type":"string"},"start_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Earliest date to include, YYYY-MM-DD.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Latest date to include, YYYY-MM-DD.","title":"End Date"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum number of rows to return (1 to 500).","title":"Limit"}},"required":["symbol"],"title":"get_lobbying_filingsArguments","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_government_contracts":{"post":{"operationId":"get_government_contracts","summary":"Get federal contract awards mapped to a company's ticker: award value, awarding agency, period of performance, descripti","description":"Get federal contract awards mapped to a company's ticker: award value, awarding agency, period of performance, description and NAICS industry. Use for \"What federal contracts has Lockheed Martin been awarded recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"symbol":{"description":"Stock ticker symbol, for example 'LMT'.","maxLength":200,"title":"Symbol","type":"string"},"start_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Earliest date to include, YYYY-MM-DD.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Latest date to include, YYYY-MM-DD.","title":"End Date"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum number of rows to return (1 to 500).","title":"Limit"}},"required":["symbol"],"title":"get_government_contractsArguments","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_patent_filings":{"post":{"operationId":"get_patent_filings","summary":"Get USPTO patents granted to a company's ticker: patent id and title, grant date, claim and citation counts, inventors, ","description":"Get USPTO patents granted to a company's ticker: patent id and title, grant date, claim and citation counts, inventors, CPC technology sections and filing-to-grant time. Use for \"Which patents was Apple granted this year and in which technology areas\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"symbol":{"description":"Stock ticker symbol, for example 'AAPL'.","maxLength":200,"title":"Symbol","type":"string"},"start_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Earliest date to include, YYYY-MM-DD.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Latest date to include, YYYY-MM-DD.","title":"End Date"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum number of rows to return (1 to 500).","title":"Limit"}},"required":["symbol"],"title":"get_patent_filingsArguments","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_news_sentiment":{"post":{"operationId":"get_news_sentiment","summary":"Get the daily AI-derived news sentiment score for a ticker, from -1 (bearish) to 1 (bullish), newest first. Use for \"Has","description":"Get the daily AI-derived news sentiment score for a ticker, from -1 (bearish) to 1 (bullish), newest first. Use for \"Has news sentiment on Apple been bullish or bearish lately\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"symbol":{"description":"Stock ticker symbol, for example 'AAPL'.","maxLength":200,"title":"Symbol","type":"string"},"start_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Earliest date to include, YYYY-MM-DD.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Latest date to include, YYYY-MM-DD.","title":"End Date"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Maximum number of rows to return (1 to 1000).","title":"Limit"}},"required":["symbol"],"title":"get_news_sentimentArguments","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_stock_news":{"post":{"operationId":"get_stock_news","summary":"Get recent financial news headlines for a ticker with publisher, link and a sentiment score from -1 to 1 where available","description":"Get recent financial news headlines for a ticker with publisher, link and a sentiment score from -1 to 1 where available. Some links are relative paths; prepend the publisher's site when a link starts with a slash. Use for \"What is the latest news on Apple and how is it scored\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"symbol":{"description":"Stock ticker symbol, for example 'AAPL'.","maxLength":200,"title":"Symbol","type":"string"},"start_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Earliest date to include, YYYY-MM-DD.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Latest date to include, YYYY-MM-DD.","title":"End Date"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Maximum number of rows to return (1 to 500).","title":"Limit"}},"required":["symbol"],"title":"get_stock_newsArguments","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_analyst_ratings":{"post":{"operationId":"get_analyst_ratings","summary":"Get Wall Street analyst rating actions for a ticker: date, firm, action (upgrade, downgrade, reiterated), rating and pri","description":"Get Wall Street analyst rating actions for a ticker: date, firm, action (upgrade, downgrade, reiterated), rating and price target. Use for \"Which analysts changed their rating on Apple recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"symbol":{"description":"Stock ticker symbol, for example 'AAPL'.","maxLength":200,"title":"Symbol","type":"string"},"start_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Earliest date to include, YYYY-MM-DD.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Latest date to include, YYYY-MM-DD.","title":"End Date"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Maximum number of rows to return (1 to 500).","title":"Limit"}},"required":["symbol"],"title":"get_analyst_ratingsArguments","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_put_call_ratio":{"post":{"operationId":"get_put_call_ratio","summary":"Get the daily options put/call ratio for a ticker with call, put and total volume and the closing price. Use for \"Is opt","description":"Get the daily options put/call ratio for a ticker with call, put and total volume and the closing price. Use for \"Is options activity on Apple leaning toward puts or calls\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"symbol":{"description":"Stock ticker symbol, for example 'AAPL'.","maxLength":200,"title":"Symbol","type":"string"},"start_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Earliest date to include, YYYY-MM-DD.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Latest date to include, YYYY-MM-DD.","title":"End Date"},"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Maximum number of rows to return (1 to 1000).","title":"Limit"}},"required":["symbol"],"title":"get_put_call_ratioArguments","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_trading":{"post":{"operationId":"get_insider_trading","summary":"Get SEC Form 4 insider transactions for a ticker: insider, role, transaction type, shares, price, value, shares owned af","description":"Get SEC Form 4 insider transactions for a ticker: insider, role, transaction type, shares, price, value, shares owned afterwards and filing link. Use for \"Have any Apple executives sold shares recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"symbol":{"description":"Stock ticker symbol, for example 'AAPL'.","maxLength":200,"title":"Symbol","type":"string"},"start_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Earliest date to include, YYYY-MM-DD.","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Latest date to include, YYYY-MM-DD.","title":"End Date"},"limit":{"anyOf":[{"maximum":500,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Maximum number of rows to return (1 to 500).","title":"Limit"}},"required":["symbol"],"title":"get_insider_tradingArguments","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}}}}