{"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/health:who/countries":{"get":{"operationId":"health_who_countries","summary":"Countries","description":"WHO country codes, optionally limited to one WHO region (AFR, AMR, SEAR, EUR, EMR, WPR).","tags":["health"],"parameters":[{"name":"region","in":"query","required":false,"schema":{"type":"string"},"example":"SEAR"}],"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/health:who/dimension-values/{dimension}":{"get":{"operationId":"health_who_dimension_values","summary":"Dimension Values","description":"Allowed values of one dimension.","tags":["health"],"parameters":[{"name":"dimension","in":"path","required":true,"schema":{"type":"string"},"example":"SEX"}],"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/health:who/dimensions":{"get":{"operationId":"health_who_dimensions","summary":"Dimensions","description":"All GHO dimensions (COUNTRY, SEX, AGEGROUP, …).","tags":["health"],"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":86400,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/health:who/indicator-data/{indicator}":{"get":{"operationId":"health_who_indicator_data","summary":"Indicator Data","description":"Observations of one indicator, filterable by place, year range and dimensions.","tags":["health"],"parameters":[{"name":"indicator","in":"path","required":true,"schema":{"type":"string"},"example":"WHOSIS_000001"},{"name":"country","in":"query","required":false,"description":"ISO3 country code","schema":{"type":"string","description":"ISO3 country code"},"example":"IDN"},{"name":"region","in":"query","required":false,"description":"WHO region code","schema":{"type":"string","description":"WHO region code"},"example":"SEAR"},{"name":"spatialDimType","in":"query","required":false,"schema":{"type":"string","enum":["COUNTRY","REGION","WORLDBANKINCOMEGROUP","GLOBAL"]}},{"name":"year","in":"query","required":false,"schema":{"type":"integer"}},{"name":"yearFrom","in":"query","required":false,"schema":{"type":"integer"}},{"name":"yearTo","in":"query","required":false,"schema":{"type":"integer"}},{"name":"dim1","in":"query","required":false,"description":"Dim1 value, e.g. SEX_BTSX","schema":{"type":"string","description":"Dim1 value, e.g. SEX_BTSX"},"example":"SEX_BTSX"},{"name":"dim2","in":"query","required":false,"schema":{"type":"string"}},{"name":"dim3","in":"query","required":false,"schema":{"type":"string"}},{"name":"orderBy","in":"query","required":false,"schema":{"type":"string","enum":["year","value","country","id"],"default":"year"}},{"name":"order","in":"query","required":false,"schema":{"type":"string","enum":["asc","desc"],"default":"desc"}},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":1000,"description":"1-based page number"}},{"name":"limit","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":100,"minimum":1,"maximum":1000,"description":"Items per page"}}],"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/health:who/indicators":{"get":{"operationId":"health_who_indicators","summary":"Indicators","description":"List or search GHO indicator codes.","tags":["health"],"parameters":[{"name":"search","in":"query","required":false,"schema":{"type":"string"},"example":"life expectancy"},{"name":"code","in":"query","required":false,"schema":{"type":"string"},"example":"WHOSIS_000001"},{"name":"page","in":"query","required":false,"description":"1-based page number","schema":{"type":"integer","default":1,"minimum":1,"maximum":500,"description":"1-based page number"}},{"name":"limit","in":"query","required":false,"description":"Items per page","schema":{"type":"integer","default":50,"minimum":1,"maximum":500,"description":"Items per page"}}],"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/health:who/regions":{"get":{"operationId":"health_who_regions","summary":"Regions","description":"WHO regions.","tags":["health"],"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":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":"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"}}}}}}}