{"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/open-data:opendatanetwork/find-all-available-data-for-some-entities":{"get":{"operationId":"open_data_opendatanetwork_find_all_available_data_for_some_entities","summary":"Find all available data for some entities","description":"GET /data/v1/availability/","tags":["open-data"],"parameters":[{"name":"entity_id","in":"query","required":true,"description":"Comma separated list of entity IDs.","schema":{"type":"string","description":"Comma separated list of entity IDs."},"example":"0100000US,0400000US53"},{"name":"app_token","in":"query","required":false,"description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…","schema":{"type":"string","description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"},{"name":"X-App-Token","in":"query","required":false,"description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0","schema":{"type":"string","description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:opendatanetwork/get-constraint-permutations-for-entities":{"get":{"operationId":"open_data_opendatanetwork_get_constraint_permutations_for_entities","summary":"Get constraint permutations for entities","description":"GET /data/v1/constraint/{variable}","tags":["open-data"],"parameters":[{"name":"variable","in":"query","required":true,"description":"Full ID of the variable to retrieve.","schema":{"type":"string","description":"Full ID of the variable to retrieve."},"example":"demographics.population.count"},{"name":"entity_id","in":"query","required":true,"description":"Comma separated list of entity IDs.","schema":{"type":"string","description":"Comma separated list of entity IDs."},"example":"0100000US,0400000US53"},{"name":"constraint","in":"query","required":true,"description":"Constraint to use.","schema":{"type":"string","description":"Constraint to use."},"example":"year"},{"name":"app_token","in":"query","required":false,"description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…","schema":{"type":"string","description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"},{"name":"X-App-Token","in":"query","required":false,"description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0","schema":{"type":"string","description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:opendatanetwork/create-a-map":{"get":{"operationId":"open_data_opendatanetwork_create_a_map","summary":"Create a map","description":"GET /data/v1/map/new","tags":["open-data"],"parameters":[{"name":"variable","in":"query","required":true,"description":"A single variable ID.","schema":{"type":"string","description":"A single variable ID."},"example":"demographics.population.count"},{"name":"entity_id","in":"query","required":true,"description":"A comma separated list of entity IDs. Entities must have the same type and represent geographical regions.","schema":{"type":"string","description":"A comma separated list of entity IDs. Entities must have the same type and represent geographical regions."},"example":"0400000US53,0400000US08"},{"name":"constraint","in":"query","required":false,"description":"Values must be specified for each constraint in the dataset. For example, to generate map data for `demographics.population.count`, you…","schema":{"type":"string","description":"Values must be specified for each constraint in the dataset. For example, to generate map data for `demographics.population.count`, you…"}},{"name":"app_token","in":"query","required":false,"description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…","schema":{"type":"string","description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"},{"name":"X-App-Token","in":"query","required":false,"description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0","schema":{"type":"string","description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:opendatanetwork/get-values-for-variables":{"get":{"operationId":"open_data_opendatanetwork_get_values_for_variables","summary":"Get values for variables","description":"GET /data/v1/values","tags":["open-data"],"parameters":[{"name":"variable","in":"query","required":true,"description":"Comma separated list of variable IDs. Defaults to retrieving all variables. It is also possible to pass in a topic such as `demographics`,…","schema":{"type":"string","description":"Comma separated list of variable IDs. Defaults to retrieving all variables. It is also possible to pass in a topic such as `demographics`,…"},"example":"demographics.population.count"},{"name":"entity_id","in":"query","required":false,"description":"Comma separated list of entity IDs. Defaults to retrieving all entities. Note that since there is currently no results pagination,…","schema":{"type":"string","description":"Comma separated list of entity IDs. Defaults to retrieving all entities. Note that since there is currently no results pagination,…"},"example":"0100000US,0400000US53"},{"name":"forecast","in":"query","required":false,"description":"Number of steps to forecast. Must be an integer between 0 and 20. Forecasts are produced using linear extrapolation on the data. They are…","schema":{"type":"number","description":"Number of steps to forecast. Must be an integer between 0 and 20. Forecasts are produced using linear extrapolation on the data. They are…"},"example":"3"},{"name":"describe","in":"query","required":false,"description":"Whether or not to produce a description of the data. Set to `true` to produce a description. Descriptions are not available if no entities…","schema":{"type":"boolean","description":"Whether or not to produce a description of the data. Set to `true` to produce a description. Descriptions are not available if no entities…"},"example":"false"},{"name":"format","in":"query","required":false,"description":"If format is set to `google`, the data frame will be formatted as a [Google Visualizations data…","schema":{"type":"string","enum":["google"],"description":"If format is set to `google`, the data frame will be formatted as a [Google Visualizations data…"}},{"name":"app_token","in":"query","required":false,"description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…","schema":{"type":"string","description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"},{"name":"X-App-Token","in":"query","required":false,"description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0","schema":{"type":"string","description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:opendatanetwork/get-entities":{"get":{"operationId":"open_data_opendatanetwork_get_entities","summary":"Get Entities","description":"GET /entity/v1","tags":["open-data"],"parameters":[{"name":"entity_id","in":"query","required":false,"description":"ID of the entity.","schema":{"type":"string","description":"ID of the entity."},"example":"0400000US53"},{"name":"entity_name","in":"query","required":false,"description":"Name of the entity.","schema":{"type":"string","description":"Name of the entity."},"example":"washington"},{"name":"entity_type","in":"query","required":false,"description":"Type of the entity.","schema":{"type":"string","description":"Type of the entity."},"example":"region.state"},{"name":"app_token","in":"query","required":false,"description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…","schema":{"type":"string","description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"},{"name":"X-App-Token","in":"query","required":false,"description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0","schema":{"type":"string","description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:opendatanetwork/find-the-relatives-of-an-entity":{"get":{"operationId":"open_data_opendatanetwork_find_the_relatives_of_an_entity","summary":"Find the relatives of an entity","description":"GET /entity/v1/{relation}","tags":["open-data"],"parameters":[{"name":"relation","in":"query","required":true,"description":"The type of relation to find.","schema":{"type":"string","enum":["parent","child","sibling","peer"],"description":"The type of relation to find."},"example":"parent"},{"name":"entity_id","in":"query","required":true,"description":"ID of the target entity.","schema":{"type":"string","description":"ID of the target entity."},"example":"0400000US53"},{"name":"variable_id","in":"query","required":false,"description":"If this parameter is included, only entities with data for the given variable will be returned. Note that this may cause the number of…","schema":{"type":"string","description":"If this parameter is included, only entities with data for the given variable will be returned. Note that this may cause the number of…"},"example":"demographics.population.seattle"},{"name":"limit","in":"query","required":false,"description":"Maximum number of entities in each group. Must be an integer from 1 to 1000.","schema":{"type":"number","default":10,"description":"Maximum number of entities in each group. Must be an integer from 1 to 1000."}},{"name":"app_token","in":"query","required":false,"description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…","schema":{"type":"string","description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"},{"name":"X-App-Token","in":"query","required":false,"description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0","schema":{"type":"string","description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:opendatanetwork/get-datasets":{"get":{"operationId":"open_data_opendatanetwork_get_datasets","summary":"Get datasets","description":"GET /search/v1/dataset","tags":["open-data"],"parameters":[{"name":"entity_id","in":"query","required":false,"description":"Entities to use in formulating the query.","schema":{"type":"string","description":"Entities to use in formulating the query."},"example":"0100000US"},{"name":"dataset_id","in":"query","required":false,"description":"If included, the search terms of the dataset will be used in the query.","schema":{"type":"string","description":"If included, the search terms of the dataset will be used in the query."},"example":"demographics.population"},{"name":"limit","in":"query","required":false,"description":"Maximum number of results to return. Must be an integer from 0 to 50000.","schema":{"type":"number","default":10,"description":"Maximum number of results to return. Must be an integer from 0 to 50000."}},{"name":"offset","in":"query","required":false,"description":"Number of results to skip. Used for pagination.","schema":{"type":"number","description":"Number of results to skip. Used for pagination."}},{"name":"app_token","in":"query","required":false,"description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…","schema":{"type":"string","description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"},{"name":"X-App-Token","in":"query","required":false,"description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0","schema":{"type":"string","description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:opendatanetwork/get-questions":{"get":{"operationId":"open_data_opendatanetwork_get_questions","summary":"Get questions","description":"GET /search/v1/question","tags":["open-data"],"parameters":[{"name":"query","in":"query","required":true,"description":"String to search against.","schema":{"type":"string","description":"String to search against."},"example":"seattle"},{"name":"limit","in":"query","required":false,"description":"Maximum number of results to return. Must be an integer from 0 to 50000.","schema":{"type":"number","default":10,"description":"Maximum number of results to return. Must be an integer from 0 to 50000."}},{"name":"offset","in":"query","required":false,"description":"Number of results to skip. Used for pagination.","schema":{"type":"number","description":"Number of results to skip. Used for pagination."}},{"name":"app_token","in":"query","required":false,"description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…","schema":{"type":"string","description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"},{"name":"X-App-Token","in":"query","required":false,"description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0","schema":{"type":"string","description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:opendatanetwork/get-suggestions":{"get":{"operationId":"open_data_opendatanetwork_get_suggestions","summary":"Get suggestions","description":"GET /suggest/v1/{type}","tags":["open-data"],"parameters":[{"name":"type","in":"query","required":true,"description":"Type of the object to find.","schema":{"type":"string","enum":["entity","category","publisher","dataset","question"],"description":"Type of the object to find."},"example":"entity"},{"name":"query","in":"query","required":true,"description":"Query to match.","schema":{"type":"string","description":"Query to match."},"example":"seattl"},{"name":"limit","in":"query","required":false,"description":"Maximum number of results to return. Must be an integer from 0 to 100.","schema":{"type":"number","default":5,"description":"Maximum number of results to return. Must be an integer from 0 to 100."}},{"name":"variable_id","in":"query","required":false,"description":"This parameter is only available when suggesting entities with `type=entity`. If it is provided, suggestions will be filtered to include…","schema":{"type":"string","description":"This parameter is only available when suggesting entities with `type=entity`. If it is provided, suggestions will be filtered to include…"},"example":"demographics.population.count"},{"name":"app_token","in":"query","required":false,"description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…","schema":{"type":"string","description":"The [Socrata App Token](https://dev.socrata.com/docs/app-tokens.html) to be used with your request. The `app_token` parameter is required…"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"},{"name":"X-App-Token","in":"query","required":false,"description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0","schema":{"type":"string","description":"e.g. cQovpGcdUT1CSzgYk0KPYdAI0"},"example":"cQovpGcdUT1CSzgYk0KPYdAI0"}],"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":60,"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"}}}}}}}