{"openapi":"3.1.0","info":{"title":"Apizie: official","version":"2.0.0","description":"One API key, one envelope, many public data sources. Success responses include a `source` block to cite. Apizie Finance endpoints (SEC EDGAR, FRED, ECB, U.S. Treasury, GLEIF, World Bank, official:*) need a Finance plan."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/official:company/profile":{"get":{"operationId":"official_company_profile","summary":"Company Profile","description":"SEC registrant profile, latest filings, GLEIF LEI record and latest annual financials (revenue, net income, assets, liabilities, equity, cash flow, EPS), each with its source filing.","tags":["official"],"x-apizie-access":"read","parameters":[{"name":"company","in":"query","required":false,"description":"Ticker or company name (SEC registrants)","schema":{"type":"string","description":"Ticker or company name (SEC registrants)"},"example":"AAPL"},{"name":"cik","in":"query","required":false,"description":"SEC Central Index Key","schema":{"type":"string","description":"SEC Central Index Key"}},{"name":"lei","in":"query","required":false,"description":"20-character LEI; works for companies outside the SEC too","schema":{"type":"string","description":"20-character LEI; works for companies outside the SEC too"}},{"name":"financials","in":"query","required":false,"description":"Include headline annual financials from XBRL","schema":{"type":"boolean","default":true,"description":"Include headline annual financials from XBRL"}},{"name":"filings","in":"query","required":false,"description":"How many recent filings to list","schema":{"type":"integer","default":5,"minimum":0,"maximum":20,"description":"How many recent filings to list"}}],"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":true,"x-apizie-status":"live"}},"/v1/official:macro/us":{"get":{"operationId":"official_macro_us","summary":"United States Snapshot","description":"Treasury par yield curve (latest day) plus FRED: effective fed funds, 10-year yield, 10y-2y spread, CPI and unemployment.","tags":["official"],"x-apizie-access":"read","parameters":[],"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":3600,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/official:macro/euro-area":{"get":{"operationId":"official_macro_euro_area","summary":"Euro Area Snapshot","description":"ECB key interest rates (deposit facility, main refinancing, marginal lending), latest HICP inflation and the EUR/USD reference rate.","tags":["official"],"x-apizie-access":"read","parameters":[],"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":3600,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/official:macro/country":{"get":{"operationId":"official_macro_country","summary":"Country Fundamentals","description":"Latest available World Bank values for GDP, growth, inflation, unemployment, population, government debt and current account for one country.","tags":["official"],"x-apizie-access":"read","parameters":[{"name":"country","in":"query","required":true,"description":"ISO2 or ISO3 country code","schema":{"type":"string","description":"ISO2 or ISO3 country code"},"example":"US"}],"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"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"official:company"},"data":{},"source":{"type":"object","description":"Where the data came from. Cite it.","properties":{"official":{"type":"boolean"},"provider":{"type":"string","example":"SEC EDGAR"},"publisher":{"type":"string","example":"U.S. Securities and Exchange Commission"},"url":{"type":"string","format":"uri","description":"A page a person can open to check the value"},"apiUrl":{"type":"string","format":"uri","description":"The official API URL that was called (credentials removed)"},"retrievedAt":{"type":"string","format":"date-time"},"license":{"type":"string"},"licenseUrl":{"type":"string","format":"uri"},"attribution":{"type":"string"},"notice":{"type":"string"}}},"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"}}}}}}}