{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:sec-edgar/search":{"get":{"operationId":"finance_sec_edgar_search","summary":"Search Filings","description":"Full-text search across EDGAR filings since 2001.","tags":["finance"],"parameters":[{"name":"q","in":"query","required":false,"description":"Search terms (use quotes for phrases)","schema":{"type":"string","description":"Search terms (use quotes for phrases)"},"example":"\"artificial intelligence\""},{"name":"company","in":"query","required":false,"description":"Ticker, company name or CIK to restrict results","schema":{"type":"string","description":"Ticker, company name or CIK to restrict results"}},{"name":"forms","in":"query","required":false,"schema":{"type":"string"},"example":"10-K,8-K"},{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":900,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:sec-edgar/company":{"get":{"operationId":"finance_sec_edgar_company","summary":"Company","description":"Company profile: CIK, tickers, industry (SIC), addresses and fiscal year end.","tags":["finance"],"parameters":[{"name":"company","in":"query","required":false,"description":"Ticker or company name","schema":{"type":"string","description":"Ticker or company name"},"example":"AAPL"},{"name":"cik","in":"query","required":false,"description":"SEC Central Index Key","schema":{"type":"string","description":"SEC Central Index Key"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/finance:sec-edgar/filings":{"get":{"operationId":"finance_sec_edgar_filings","summary":"Filings","description":"A company's recent filings, optionally filtered by form type.","tags":["finance"],"parameters":[{"name":"company","in":"query","required":false,"description":"Ticker or company name","schema":{"type":"string","description":"Ticker or company name"},"example":"AAPL"},{"name":"cik","in":"query","required":false,"description":"SEC Central Index Key","schema":{"type":"string","description":"SEC Central Index Key"}},{"name":"form","in":"query","required":false,"schema":{"type":"string"},"example":"10-K"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"minimum":1}},{"name":"count","in":"query","required":false,"description":"Number of rows to return","schema":{"type":"integer","default":25,"minimum":1,"maximum":200,"description":"Number of rows to return"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":900,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/finance:sec-edgar/concept":{"get":{"operationId":"finance_sec_edgar_concept","summary":"Concept","description":"All reported values of one XBRL concept (e.g. Revenues) for a company.","tags":["finance"],"parameters":[{"name":"company","in":"query","required":false,"description":"Ticker or company name","schema":{"type":"string","description":"Ticker or company name"},"example":"AAPL"},{"name":"cik","in":"query","required":false,"description":"SEC Central Index Key","schema":{"type":"string","description":"SEC Central Index Key"}},{"name":"tag","in":"query","required":false,"schema":{"type":"string","default":"Revenues"},"example":"NetIncomeLoss"},{"name":"taxonomy","in":"query","required":false,"schema":{"type":"string","enum":["us-gaap","ifrs-full","dei","srt"],"default":"us-gaap"}},{"name":"period","in":"query","required":false,"schema":{"type":"string","enum":["all","annual","quarterly"],"default":"all"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":21600,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}