{"openapi":"3.1.0","info":{"title":"sec-api.io (BYOK) API","version":"0.1.0","description":"sec-api.io (BYOK) lets an AI assistant read your own sec-api.io data through the sec-api.io API with a key you supply (sec-api.io API key (paste it as is)). Read-only: 7 tools (search_filings, full_text_search, search_insider_trades, search_13f_holdings, search_13d_13g, get_shares_and_float, search_edgar_entities). The BYOK key travels with each request, is used for that one call only and is...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-secapi.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-secapi/docs"},"termsOfService":"https://connectorbay.com/byok-secapi/terms"},"servers":[{"url":"https://byok-secapi.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-secapi/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/search_filings":{"post":{"operationId":"search_filings","summary":"Search the metadata of EDGAR filings with a Lucene query such as formType:\"10-K\" AND ticker:AAPL, newest first. Use for ","description":"Search the metadata of EDGAR filings with a Lucene query such as formType:\"10-K\" AND ticker:AAPL, newest first. Use for \"Show Apple's latest 10-K filings\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"description":"Lucene search expression over filing fields such as ticker, cik, formType, filedAt, items, for example formType:\"8-K\" AND items:\"2.02\".","maxLength":3500,"title":"Query","type":"string"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Position of the first result, 0 to 10000, for paging (documented maximum 10000).","title":"Offset"},"size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 50).","title":"Size"}},"required":["query"],"title":"search_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/full_text_search":{"post":{"operationId":"full_text_search","summary":"Search the full text of EDGAR filings and exhibits since 2001 for a word or exact phrase, with an optional date range. 1","description":"Search the full text of EDGAR filings and exhibits since 2001 for a word or exact phrase, with an optional date range. 100 results per page. Use for \"Which filings in early 2024 mention \"substantial doubt\"\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"description":"Search text: a word, an \"exact phrase\", OR, a leading - or NOT to exclude, trailing * wildcard.","maxLength":500,"title":"Query","type":"string"},"start_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Earliest filing date, YYYY-MM-DD (default 30 days ago).","title":"Start Date"},"end_date":{"anyOf":[{"maxLength":10,"type":"string"},{"type":"null"}],"default":null,"description":"Latest filing date, YYYY-MM-DD (default today).","title":"End Date"},"page":{"anyOf":[{"maxLength":6,"type":"string"},{"type":"null"}],"default":"1","description":"Page number as text, starting at 1 (100 filings per page).","title":"Page"}},"required":["query"],"title":"full_text_searchArguments","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/search_insider_trades":{"post":{"operationId":"search_insider_trades","summary":"Search insider ownership filings (Forms 3, 4 and 5) by Lucene query, for example issuer.tradingSymbol:TSLA, with owner, ","description":"Search insider ownership filings (Forms 3, 4 and 5) by Lucene query, for example issuer.tradingSymbol:TSLA, with owner, role and transactions. Use for \"What insider transactions did Tesla insiders report recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"description":"Lucene search expression, for example issuer.tradingSymbol:TSLA or reportingOwner.relationship.isDirector:True AND issuer.tradingSymbol:AMZN.","maxLength":3500,"title":"Query","type":"string"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Position of the first result, 0 to 10000, for paging (documented maximum 10000).","title":"Offset"},"size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 50).","title":"Size"}},"required":["query"],"title":"search_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/search_13f_holdings":{"post":{"operationId":"search_13f_holdings","summary":"Search Form 13F institutional portfolio filings by Lucene query such as cik:1633901, returning each filing with its list","description":"Search Form 13F institutional portfolio filings by Lucene query such as cik:1633901, returning each filing with its list of holdings. Use for \"What did the fund with CIK 1633901 hold in its latest 13F\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"description":"Lucene search expression, for example cik:1633901 AND periodOfReport:[2025-01-01 TO 2025-12-31] or holdings.ticker:TSLA.","maxLength":3500,"title":"Query","type":"string"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Position of the first result, 0 to 10000, for paging (documented maximum 10000).","title":"Offset"},"size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"How many results to return (1 to 50).","title":"Size"}},"required":["query"],"title":"search_13f_holdingsArguments","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/search_13d_13g":{"post":{"operationId":"search_13d_13g","summary":"Search Schedule 13D and 13G filings about large (5 percent and above) stakes by Lucene query, with filers, issuer and ow","description":"Search Schedule 13D and 13G filings about large (5 percent and above) stakes by Lucene query, with filers, issuer and owners. Use for \"Which 13D filings disclosed stakes of 10 percent or more recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"description":"Lucene search expression, for example nameOfIssuer:\"Esperion\" or owners.typeOfReportingPerson:(IA, IC).","maxLength":3500,"title":"Query","type":"string"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Position of the first result, 0 to 10000, for paging (documented maximum 10000).","title":"Offset"},"size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 50).","title":"Size"}},"required":["query"],"title":"search_13d_13gArguments","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_shares_and_float":{"post":{"operationId":"get_shares_and_float","summary":"Get a company's reported outstanding shares per class and public float over time, by ticker or by CIK (give one of them)","description":"Get a company's reported outstanding shares per class and public float over time, by ticker or by CIK (give one of them). Use for \"How many shares of Alphabet are outstanding\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"ticker":{"anyOf":[{"maxLength":15,"type":"string"},{"type":"null"}],"default":null,"description":"Ticker symbol, for example 'AAPL'.","title":"Ticker"},"cik":{"anyOf":[{"maxLength":12,"type":"string"},{"type":"null"}],"default":null,"description":"CIK without leading zeros, for example '1067983'.","title":"Cik"}},"title":"get_shares_and_floatArguments","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/search_edgar_entities":{"post":{"operationId":"search_edgar_entities","summary":"Search EDGAR filer entities by Lucene query, for example cik:1318605, returning name, SIC industry, state of incorporati","description":"Search EDGAR filer entities by Lucene query, for example cik:1318605, returning name, SIC industry, state of incorporation and filer category. Use for \"Look up the EDGAR entity record for CIK 1318605\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"description":"Lucene search expression over entity fields such as cik, name, sic, stateOfIncorporation, for example name:\"tesla\".","maxLength":3500,"title":"Query","type":"string"},"offset":{"anyOf":[{"maximum":10000,"minimum":0,"type":"integer"},{"type":"null"}],"default":0,"description":"Position of the first result, 0 to 10000, for paging (documented maximum 10000).","title":"Offset"},"size":{"anyOf":[{"maximum":50,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many results to return (1 to 50).","title":"Size"}},"required":["query"],"title":"search_edgar_entitiesArguments","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}}}}