{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/finance:ecb/dataflows":{"get":{"operationId":"finance_ecb_dataflows","summary":"Dataflows","description":"List of available ECB dataflows (datasets).","tags":["finance"],"parameters":[{"name":"agency","in":"query","required":false,"schema":{"type":"string","default":"ECB"}},{"name":"query","in":"query","required":false,"description":"Filter by id or name","schema":{"type":"string","description":"Filter by id or name"}}],"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":false,"x-apizie-status":"live"}},"/v1/finance:ecb/series":{"get":{"operationId":"finance_ecb_series","summary":"Series","description":"Raw access to any ECB dataflow/series key (SDMX).","tags":["finance"],"parameters":[{"name":"dataflow","in":"query","required":true,"description":"Dataflow id, e.g. EXR, ICP, FM","schema":{"type":"string","description":"Dataflow id, e.g. EXR, ICP, FM"},"example":"EXR"},{"name":"key","in":"query","required":false,"description":"Series key with '.'-separated dimensions; empty dimension = wildcard","schema":{"type":"string","description":"Series key with '.'-separated dimensions; empty dimension = wildcard"},"example":"D.USD.EUR.SP00.A"},{"name":"from","in":"query","required":false,"description":"Start period, e.g. 2024-01 or 2024-01-31","schema":{"type":"string","description":"Start period, e.g. 2024-01 or 2024-01-31"}},{"name":"to","in":"query","required":false,"description":"End period","schema":{"type":"string","description":"End period"}},{"name":"last","in":"query","required":false,"description":"Only the last N observations","schema":{"type":"integer","minimum":1,"description":"Only the last N observations"}},{"name":"first","in":"query","required":false,"schema":{"type":"integer","minimum":1}},{"name":"detail","in":"query","required":false,"schema":{"type":"string","enum":["full","dataonly","serieskeysonly","nodata"]}},{"name":"updatedAfter","in":"query","required":false,"schema":{"type":"string"}},{"name":"history","in":"query","required":false,"schema":{"type":"string","enum":["true","false"]}},{"name":"length","in":"query","required":false,"description":"Max series returned","schema":{"type":"integer","minimum":1,"maximum":1000,"description":"Max series returned"}}],"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/finance:ecb/exchange-rates":{"get":{"operationId":"finance_ecb_exchange_rates","summary":"Exchange Rates","description":"Euro foreign exchange reference rates (units of currency per 1 EUR).","tags":["finance"],"parameters":[{"name":"currency","in":"query","required":false,"description":"Currency code(s), '+'-separated","schema":{"type":"string","default":"USD","description":"Currency code(s), '+'-separated"},"example":"USD+IDR"},{"name":"frequency","in":"query","required":false,"schema":{"type":"string","enum":["D","M","Q","A"],"default":"D"}},{"name":"from","in":"query","required":false,"description":"Start period, e.g. 2024-01 or 2024-01-31","schema":{"type":"string","description":"Start period, e.g. 2024-01 or 2024-01-31"}},{"name":"to","in":"query","required":false,"description":"End period","schema":{"type":"string","description":"End period"}},{"name":"last","in":"query","required":false,"description":"Only the last N observations","schema":{"type":"integer","minimum":1,"description":"Only the last N observations"}}],"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/finance:ecb/hicp":{"get":{"operationId":"finance_ecb_hicp","summary":"HICP Inflation","description":"Harmonised Index of Consumer Prices for the euro area or a member state.","tags":["finance"],"parameters":[{"name":"item","in":"query","required":false,"description":"COICOP item code; 000000 = all items","schema":{"type":"string","default":"000000","description":"COICOP item code; 000000 = all items"}},{"name":"area","in":"query","required":false,"description":"U2 = euro area, or ISO2 country e.g. DE","schema":{"type":"string","default":"U2","description":"U2 = euro area, or ISO2 country e.g. DE"}},{"name":"measure","in":"query","required":false,"description":"ANR = annual rate of change","schema":{"type":"string","enum":["ANR","INX","ANR_S","MRR","CTG","CTG_S","WGT"],"default":"ANR","description":"ANR = annual rate of change"}},{"name":"from","in":"query","required":false,"description":"Start period, e.g. 2024-01 or 2024-01-31","schema":{"type":"string","description":"Start period, e.g. 2024-01 or 2024-01-31"}},{"name":"to","in":"query","required":false,"description":"End period","schema":{"type":"string","description":"End period"}},{"name":"last","in":"query","required":false,"description":"Only the last N observations","schema":{"type":"integer","minimum":1,"description":"Only the last N observations"}}],"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"}},"/v1/finance:ecb/key-rates":{"get":{"operationId":"finance_ecb_key_rates","summary":"Key Interest Rates","description":"ECB policy rates: main refinancing (MRR), deposit facility (DFR) and marginal lending (MLF).","tags":["finance"],"parameters":[{"name":"rate","in":"query","required":false,"schema":{"type":"string","enum":["MRR","DFR","MLF","all"],"default":"all"}},{"name":"from","in":"query","required":false,"description":"Start period, e.g. 2024-01 or 2024-01-31","schema":{"type":"string","description":"Start period, e.g. 2024-01 or 2024-01-31"}},{"name":"to","in":"query","required":false,"description":"End period","schema":{"type":"string","description":"End period"}},{"name":"last","in":"query","required":false,"description":"Only the last N observations","schema":{"type":"integer","minimum":1,"description":"Only the last N observations"}}],"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"}}},"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"}}}}}}}