{"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:fred/category":{"get":{"operationId":"finance_fred_category","summary":"Category","description":"A FRED category with its child categories and series.","tags":["finance"],"parameters":[{"name":"category","in":"query","required":false,"description":"Category id (0 = root)","schema":{"type":"integer","default":0,"minimum":0,"description":"Category id (0 = root)"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"minimum":1}}],"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:fred/observations-vintage":{"get":{"operationId":"finance_fred_observations_vintage","summary":"Observations Vintage","description":"Series values as they were known on specific past vintage dates (point-in-time).","tags":["finance"],"parameters":[{"name":"series","in":"query","required":false,"description":"FRED series id","schema":{"type":"string","default":"DGS10","description":"FRED series id"},"example":"CPIAUCSL"},{"name":"vintages","in":"query","required":false,"description":"Comma-separated vintage dates","schema":{"type":"string","description":"Comma-separated vintage dates"},"example":"2020-01-15,2021-01-15"},{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}},{"name":"length","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100000}}],"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:fred/release-dates":{"get":{"operationId":"finance_fred_release_dates","summary":"Release Dates","description":"Scheduled and past release dates, for all releases or one release.","tags":["finance"],"parameters":[{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}},{"name":"release","in":"query","required":false,"description":"Release id","schema":{"type":"integer","minimum":1,"description":"Release id"}},{"name":"year","in":"query","required":false,"schema":{"type":"integer","minimum":1900,"maximum":2100}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"minimum":1}}],"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:fred/releases":{"get":{"operationId":"finance_fred_releases","summary":"Releases","description":"Economic data releases published on FRED.","tags":["finance"],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"minimum":1}},{"name":"query","in":"query","required":false,"description":"Filter by release name","schema":{"type":"string","description":"Filter by release 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:fred/series-observations":{"get":{"operationId":"finance_fred_series_observations","summary":"Series Observations","description":"Data points of a series, with optional unit transformation and frequency aggregation.","tags":["finance"],"parameters":[{"name":"series","in":"query","required":false,"description":"FRED series id","schema":{"type":"string","default":"DGS10","description":"FRED series id"},"example":"CPIAUCSL"},{"name":"from","in":"query","required":false,"schema":{"type":"string"}},{"name":"to","in":"query","required":false,"schema":{"type":"string"}},{"name":"transformation","in":"query","required":false,"schema":{"type":"string","enum":["lin","chg","ch1","pch","pc1","pca","cch","cca","log"]}},{"name":"frequency","in":"query","required":false,"schema":{"type":"string","enum":["Daily","Weekly","Biweekly","Monthly","Quarterly","Semiannual","Annual"]}},{"name":"aggregation","in":"query","required":false,"schema":{"type":"string","enum":["avg","sum","eop"]}},{"name":"length","in":"query","required":false,"description":"Keep only the latest N observations","schema":{"type":"integer","minimum":1,"maximum":100000,"description":"Keep only the latest 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":true,"x-apizie-status":"live"}},"/v1/finance:fred/series-search":{"get":{"operationId":"finance_fred_series_search","summary":"Series Search","description":"Search series by keywords.","tags":["finance"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"example":"indonesia inflation"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"minimum":1}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","enum":["relevance","popularity","title","frequency","units","seasonality","updated","start","end"],"default":"relevance"}}],"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:fred/series":{"get":{"operationId":"finance_fred_series","summary":"Series","description":"Metadata for one series.","tags":["finance"],"parameters":[{"name":"series","in":"query","required":false,"description":"FRED series id","schema":{"type":"string","default":"DGS10","description":"FRED series id"},"example":"CPIAUCSL"}],"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:fred/sources":{"get":{"operationId":"finance_fred_sources","summary":"Sources","description":"Institutions that provide data to FRED.","tags":["finance"],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"minimum":1}},{"name":"query","in":"query","required":false,"schema":{"type":"string"}}],"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:fred/tags":{"get":{"operationId":"finance_fred_tags","summary":"Tags","description":"FRED tags ordered by popularity.","tags":["finance"],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"minimum":1}}],"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:fred/vintage-dates":{"get":{"operationId":"finance_fred_vintage_dates","summary":"Vintage Dates","description":"Dates on which a series was revised or newly released.","tags":["finance"],"parameters":[{"name":"series","in":"query","required":false,"description":"FRED series id","schema":{"type":"string","default":"DGS10","description":"FRED series id"},"example":"CPIAUCSL"},{"name":"length","in":"query","required":false,"description":"Keep only the latest N dates","schema":{"type":"integer","minimum":1,"maximum":10000,"description":"Keep only the latest N dates"}}],"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"}}},"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"}}}}}}}