openapi-directory/api/openaq.local.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.2","servers":[{"url":"http://openaq.local"}],"info":{"description":"API for OpenAQ LCS","title":"OpenAQ","version":"2.0.0","x-apisguru-categories":["location"],"x-origin":[{"format":"openapi","url":"https://docs.openaq.org/openapi.json","version":"3.0"}],"x-providerName":"openaq.local"},"paths":{"/favicon.ico":{"get":{"operationId":"favico_favicon_ico_get","responses":{"200":{"content":{"application/json":{"schema":{}}},"description":"Successful Response"}},"summary":"Favico"}},"/ping":{"get":{"description":"Sanity check.\nThis will let the user know that the service is operational.\nAnd this path operation will:\n* show a lifesign","operationId":"pong_ping_get","responses":{"200":{"content":{"application/json":{"schema":{}}},"description":"Successful Response"}},"summary":"Pong"}},"/v1/cities":{"get":{"operationId":"cities_getv1_v1_cities_get","parameters":[{"description":"Change the number of results returned.","in":"query","name":"limit","required":false,"schema":{"default":100,"description":"Change the number of results returned.","exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Limit","type":"integer"}},{"description":"Paginate through results.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Paginate through results.","exclusiveMinimum":true,"maximum":6000,"minimum":0,"title":"Page","type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":10000,"minimum":0,"title":"Offset","type":"integer"}},{"description":"Define sort order.","in":"query","name":"sort","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Sort"}],"default":"asc","description":"Define sort order."}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","in":"query","name":"country_id","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","title":"Country Id","type":"string"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","in":"query","name":"country","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","items":{"maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","type":"string"},"title":"Country","type":"array"}},{"description":"\n        Limit results by a certain city or cities.\n        (ex. ?city=Chicago or ?city=Chicago&city=Boston)\n        ","in":"query","name":"city","required":false,"schema":{"description":"\n        Limit results by a certain city or cities.\n        (ex. ?city=Chicago or ?city=Chicago&city=Boston)\n        ","items":{"type":"string"},"title":"City","type":"array"}},{"description":"Order by a field","in":"query","name":"order_by","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/CitiesOrder"}],"default":"city","description":"Order by a field"}},{"in":"query","name":"entity","required":false,"schema":{"title":"Entity","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAQCitiesResult"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Provides a simple listing of cities within the platform","tags":["v1"]}},"/v1/countries":{"get":{"operationId":"countries_getv1_v1_countries_get","parameters":[{"in":"query","name":"limit","required":false,"schema":{"default":200,"title":"Limit","type":"integer"}},{"description":"Paginate through results.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Paginate through results.","exclusiveMinimum":true,"maximum":6000,"minimum":0,"title":"Page","type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":10000,"minimum":0,"title":"Offset","type":"integer"}},{"description":"Define sort order.","in":"query","name":"sort","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Sort"}],"default":"asc","description":"Define sort order."}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","in":"query","name":"country_id","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","title":"Country Id","type":"string"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","in":"query","name":"country","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","items":{"maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","type":"string"},"title":"Country","type":"array"}},{"in":"query","name":"order_by","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/CountriesOrder"}],"default":"country"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAQCountriesResult"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Countries Getv1","tags":["v1"]}},"/v1/countries/{country_id}":{"get":{"operationId":"countries_get_v1_countries__country_id__get","parameters":[{"in":"path","name":"country_id","required":true,"schema":{"maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","title":"Country Id","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"default":200,"title":"Limit","type":"integer"}},{"description":"Paginate through results.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Paginate through results.","exclusiveMinimum":true,"maximum":6000,"minimum":0,"title":"Page","type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":10000,"minimum":0,"title":"Offset","type":"integer"}},{"description":"Define sort order.","in":"query","name":"sort","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Sort"}],"default":"asc","description":"Define sort order."}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","in":"query","name":"country","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","items":{"maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","type":"string"},"title":"Country","type":"array"}},{"in":"query","name":"order_by","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/CountriesOrder"}],"default":"country"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAQCountriesResult"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Countries Get","tags":["v1"]}},"/v1/latest":{"get":{"operationId":"latest_v1_get_v1_latest_get","parameters":[{"description":"Change the number of results returned.","in":"query","name":"limit","required":false,"schema":{"default":100,"description":"Change the number of results returned.","exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Limit","type":"integer"}},{"description":"Paginate through results.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Paginate through results.","exclusiveMinimum":true,"maximum":6000,"minimum":0,"title":"Page","type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":10000,"minimum":0,"title":"Offset","type":"integer"}},{"description":"Sort Direction","in":"query","name":"sort","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Sort"}],"default":"desc","description":"Sort Direction"}},{"in":"query","name":"has_geo","required":false,"schema":{"title":"Has Geo","type":"boolean"}},{"in":"query","name":"parameter_id","required":false,"schema":{"title":"Parameter Id","type":"integer"}},{"in":"query","name":"parameter","required":false,"schema":{"items":{"anyOf":[{"exclusiveMinimum":true,"maximum":2147483647,"minimum":0,"type":"integer"},{"type":"string"}]},"title":"Parameter","type":"array"}},{"in":"query","name":"unit","required":false,"schema":{"items":{"type":"string"},"title":"Unit","type":"array"}},{"in":"query","name":"coordinates","required":false,"schema":{"pattern":"^-?\\d{1,2}\\.?\\d{0,8},-?1?\\d{1,2}\\.?\\d{0,8}$","title":"Coordinates","type":"string"}},{"in":"query","name":"radius","required":false,"schema":{"default":1000,"exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Radius","type":"integer"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","in":"query","name":"country_id","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","title":"Country Id","type":"string"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","in":"query","name":"country","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","items":{"maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","type":"string"},"title":"Country","type":"array"}},{"description":"\n        Limit results by a certain city or cities.\n        (ex. ?city=Chicago or ?city=Chicago&city=Boston)\n        ","in":"query","name":"city","required":false,"schema":{"description":"\n        Limit results by a certain city or cities.\n        (ex. ?city=Chicago or ?city=Chicago&city=Boston)\n        ","items":{"type":"string"},"title":"City","type":"array"}},{"in":"query","name":"location_id","required":false,"schema":{"title":"Location Id","type":"integer"}},{"in":"query","name":"location","required":false,"schema":{"items":{"anyOf":[{"type":"integer"},{"type":"string"}]},"title":"Location","type":"array"}},{"description":"Order by a field","in":"query","name":"order_by","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/LocationsOrder"}],"default":"lastUpdated","description":"Order by a field"}},{"description":"Location is mobile","in":"query","name":"isMobile","required":false,"schema":{"description":"Location is mobile","title":"Ismobile","type":"boolean"}},{"description":"Data is the product of a previous analysis/aggregation and not raw measurements","in":"query","name":"isAnalysis","required":false,"schema":{"description":"Data is the product of a previous analysis/aggregation and not raw measurements","title":"Isanalysis","type":"boolean"}},{"description":"Name of the data source","in":"query","name":"sourceName","required":false,"schema":{"description":"Name of the data source","items":{"type":"string"},"title":"Sourcename","type":"array"}},{"description":"Source entity type.","in":"query","name":"entity","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/EntityTypes"}],"description":"Source entity type."}},{"description":"Type of Sensor","in":"query","name":"sensorType","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/SensorTypes"}],"description":"Type of Sensor"}},{"description":"Model Name of Sensor","in":"query","name":"modelName","required":false,"schema":{"description":"Model Name of Sensor","items":{"type":"string"},"title":"Modelname","type":"array"}},{"description":"Manufacturer of Sensor","in":"query","name":"manufacturerName","required":false,"schema":{"description":"Manufacturer of Sensor","items":{"type":"string"},"title":"Manufacturername","type":"array"}},{"in":"query","name":"dumpRaw","required":false,"schema":{"default":false,"title":"Dumpraw","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAQResult"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Latest V1 Get","tags":["v1"]}},"/v1/latest/{location_id}":{"get":{"operationId":"latest_v1_get_v1_latest__location_id__get","parameters":[{"in":"path","name":"location_id","required":true,"schema":{"title":"Location Id","type":"integer"}},{"description":"Change the number of results returned.","in":"query","name":"limit","required":false,"schema":{"default":100,"description":"Change the number of results returned.","exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Limit","type":"integer"}},{"description":"Paginate through results.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Paginate through results.","exclusiveMinimum":true,"maximum":6000,"minimum":0,"title":"Page","type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":10000,"minimum":0,"title":"Offset","type":"integer"}},{"description":"Sort Direction","in":"query","name":"sort","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Sort"}],"default":"desc","description":"Sort Direction"}},{"in":"query","name":"has_geo","required":false,"schema":{"title":"Has Geo","type":"boolean"}},{"in":"query","name":"parameter_id","required":false,"schema":{"title":"Parameter Id","type":"integer"}},{"in":"query","name":"parameter","required":false,"schema":{"items":{"anyOf":[{"exclusiveMinimum":true,"maximum":2147483647,"minimum":0,"type":"integer"},{"type":"string"}]},"title":"Parameter","type":"array"}},{"in":"query","name":"unit","required":false,"schema":{"items":{"type":"string"},"title":"Unit","type":"array"}},{"in":"query","name":"coordinates","required":false,"schema":{"pattern":"^-?\\d{1,2}\\.?\\d{0,8},-?1?\\d{1,2}\\.?\\d{0,8}$","title":"Coordinates","type":"string"}},{"in":"query","name":"radius","required":false,"schema":{"default":1000,"exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Radius","type":"integer"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","in":"query","name":"country_id","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","title":"Country Id","type":"string"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","in":"query","name":"country","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","items":{"maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","type":"string"},"title":"Country","type":"array"}},{"description":"\n        Limit results by a certain city or cities.\n        (ex. ?city=Chicago or ?city=Chicago&city=Boston)\n        ","in":"query","name":"city","required":false,"schema":{"description":"\n        Limit results by a certain city or cities.\n        (ex. ?city=Chicago or ?city=Chicago&city=Boston)\n        ","items":{"type":"string"},"title":"City","type":"array"}},{"in":"query","name":"location","required":false,"schema":{"items":{"anyOf":[{"type":"integer"},{"type":"string"}]},"title":"Location","type":"array"}},{"description":"Order by a field","in":"query","name":"order_by","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/LocationsOrder"}],"default":"lastUpdated","description":"Order by a field"}},{"description":"Location is mobile","in":"query","name":"isMobile","required":false,"schema":{"description":"Location is mobile","title":"Ismobile","type":"boolean"}},{"description":"Data is the product of a previous analysis/aggregation and not raw measurements","in":"query","name":"isAnalysis","required":false,"schema":{"description":"Data is the product of a previous analysis/aggregation and not raw measurements","title":"Isanalysis","type":"boolean"}},{"description":"Name of the data source","in":"query","name":"sourceName","required":false,"schema":{"description":"Name of the data source","items":{"type":"string"},"title":"Sourcename","type":"array"}},{"description":"Source entity type.","in":"query","name":"entity","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/EntityTypes"}],"description":"Source entity type."}},{"description":"Type of Sensor","in":"query","name":"sensorType","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/SensorTypes"}],"description":"Type of Sensor"}},{"description":"Model Name of Sensor","in":"query","name":"modelName","required":false,"schema":{"description":"Model Name of Sensor","items":{"type":"string"},"title":"Modelname","type":"array"}},{"description":"Manufacturer of Sensor","in":"query","name":"manufacturerName","required":false,"schema":{"description":"Manufacturer of Sensor","items":{"type":"string"},"title":"Manufacturername","type":"array"}},{"in":"query","name":"dumpRaw","required":false,"schema":{"default":false,"title":"Dumpraw","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAQResult"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Latest V1 Get","tags":["v1"]}},"/v1/locations":{"get":{"operationId":"locationsv1_get_v1_locations_get","parameters":[{"description":"Change the number of results returned.","in":"query","name":"limit","required":false,"schema":{"default":100,"description":"Change the number of results returned.","exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Limit","type":"integer"}},{"description":"Paginate through results.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Paginate through results.","exclusiveMinimum":true,"maximum":6000,"minimum":0,"title":"Page","type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":10000,"minimum":0,"title":"Offset","type":"integer"}},{"description":"Sort Direction","in":"query","name":"sort","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Sort"}],"default":"desc","description":"Sort Direction"}},{"in":"query","name":"has_geo","required":false,"schema":{"title":"Has Geo","type":"boolean"}},{"in":"query","name":"parameter_id","required":false,"schema":{"title":"Parameter Id","type":"integer"}},{"in":"query","name":"parameter","required":false,"schema":{"items":{"anyOf":[{"exclusiveMinimum":true,"maximum":2147483647,"minimum":0,"type":"integer"},{"type":"string"}]},"title":"Parameter","type":"array"}},{"in":"query","name":"unit","required":false,"schema":{"items":{"type":"string"},"title":"Unit","type":"array"}},{"in":"query","name":"coordinates","required":false,"schema":{"pattern":"^-?\\d{1,2}\\.?\\d{0,8},-?1?\\d{1,2}\\.?\\d{0,8}$","title":"Coordinates","type":"string"}},{"in":"query","name":"radius","required":false,"schema":{"default":1000,"exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Radius","type":"integer"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","in":"query","name":"country_id","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","title":"Country Id","type":"string"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","in":"query","name":"country","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","items":{"maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","type":"string"},"title":"Country","type":"array"}},{"description":"\n        Limit results by a certain city or cities.\n        (ex. ?city=Chicago or ?city=Chicago&city=Boston)\n        ","in":"query","name":"city","required":false,"schema":{"description":"\n        Limit results by a certain city or cities.\n        (ex. ?city=Chicago or ?city=Chicago&city=Boston)\n        ","items":{"type":"string"},"title":"City","type":"array"}},{"in":"query","name":"location_id","required":false,"schema":{"title":"Location Id","type":"integer"}},{"in":"query","name":"location","required":false,"schema":{"items":{"anyOf":[{"type":"integer"},{"type":"string"}]},"title":"Location","type":"array"}},{"description":"Order by a field","in":"query","name":"order_by","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/LocationsOrder"}],"default":"lastUpdated","description":"Order by a field"}},{"description":"Location is mobile","in":"query","name":"isMobile","required":false,"schema":{"description":"Location is mobile","title":"Ismobile","type":"boolean"}},{"description":"Data is the product of a previous analysis/aggregation and not raw measurements","in":"query","name":"isAnalysis","required":false,"schema":{"description":"Data is the product of a previous analysis/aggregation and not raw measurements","title":"Isanalysis","type":"boolean"}},{"description":"Name of the data source","in":"query","name":"sourceName","required":false,"schema":{"description":"Name of the data source","items":{"type":"string"},"title":"Sourcename","type":"array"}},{"description":"Source entity type.","in":"query","name":"entity","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/EntityTypes"}],"description":"Source entity type."}},{"description":"Type of Sensor","in":"query","name":"sensorType","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/SensorTypes"}],"description":"Type of Sensor"}},{"description":"Model Name of Sensor","in":"query","name":"modelName","required":false,"schema":{"description":"Model Name of Sensor","items":{"type":"string"},"title":"Modelname","type":"array"}},{"description":"Manufacturer of Sensor","in":"query","name":"manufacturerName","required":false,"schema":{"description":"Manufacturer of Sensor","items":{"type":"string"},"title":"Manufacturername","type":"array"}},{"in":"query","name":"dumpRaw","required":false,"schema":{"default":false,"title":"Dumpraw","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAQResult"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Locationsv1 Get","tags":["v1"]}},"/v1/locations/{location_id}":{"get":{"operationId":"locationsv1_get_v1_locations__location_id__get","parameters":[{"in":"path","name":"location_id","required":true,"schema":{"title":"Location Id","type":"integer"}},{"description":"Change the number of results returned.","in":"query","name":"limit","required":false,"schema":{"default":100,"description":"Change the number of results returned.","exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Limit","type":"integer"}},{"description":"Paginate through results.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Paginate through results.","exclusiveMinimum":true,"maximum":6000,"minimum":0,"title":"Page","type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":10000,"minimum":0,"title":"Offset","type":"integer"}},{"description":"Sort Direction","in":"query","name":"sort","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Sort"}],"default":"desc","description":"Sort Direction"}},{"in":"query","name":"has_geo","required":false,"schema":{"title":"Has Geo","type":"boolean"}},{"in":"query","name":"parameter_id","required":false,"schema":{"title":"Parameter Id","type":"integer"}},{"in":"query","name":"parameter","required":false,"schema":{"items":{"anyOf":[{"exclusiveMinimum":true,"maximum":2147483647,"minimum":0,"type":"integer"},{"type":"string"}]},"title":"Parameter","type":"array"}},{"in":"query","name":"unit","required":false,"schema":{"items":{"type":"string"},"title":"Unit","type":"array"}},{"in":"query","name":"coordinates","required":false,"schema":{"pattern":"^-?\\d{1,2}\\.?\\d{0,8},-?1?\\d{1,2}\\.?\\d{0,8}$","title":"Coordinates","type":"string"}},{"in":"query","name":"radius","required":false,"schema":{"default":1000,"exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Radius","type":"integer"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","in":"query","name":"country_id","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","title":"Country Id","type":"string"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","in":"query","name":"country","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","items":{"maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","type":"string"},"title":"Country","type":"array"}},{"description":"\n        Limit results by a certain city or cities.\n        (ex. ?city=Chicago or ?city=Chicago&city=Boston)\n        ","in":"query","name":"city","required":false,"schema":{"description":"\n        Limit results by a certain city or cities.\n        (ex. ?city=Chicago or ?city=Chicago&city=Boston)\n        ","items":{"type":"string"},"title":"City","type":"array"}},{"in":"query","name":"location","required":false,"schema":{"items":{"anyOf":[{"type":"integer"},{"type":"string"}]},"title":"Location","type":"array"}},{"description":"Order by a field","in":"query","name":"order_by","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/LocationsOrder"}],"default":"lastUpdated","description":"Order by a field"}},{"description":"Location is mobile","in":"query","name":"isMobile","required":false,"schema":{"description":"Location is mobile","title":"Ismobile","type":"boolean"}},{"description":"Data is the product of a previous analysis/aggregation and not raw measurements","in":"query","name":"isAnalysis","required":false,"schema":{"description":"Data is the product of a previous analysis/aggregation and not raw measurements","title":"Isanalysis","type":"boolean"}},{"description":"Name of the data source","in":"query","name":"sourceName","required":false,"schema":{"description":"Name of the data source","items":{"type":"string"},"title":"Sourcename","type":"array"}},{"description":"Source entity type.","in":"query","name":"entity","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/EntityTypes"}],"description":"Source entity type."}},{"description":"Type of Sensor","in":"query","name":"sensorType","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/SensorTypes"}],"description":"Type of Sensor"}},{"description":"Model Name of Sensor","in":"query","name":"modelName","required":false,"schema":{"description":"Model Name of Sensor","items":{"type":"string"},"title":"Modelname","type":"array"}},{"description":"Manufacturer of Sensor","in":"query","name":"manufacturerName","required":false,"schema":{"description":"Manufacturer of Sensor","items":{"type":"string"},"title":"Manufacturername","type":"array"}},{"in":"query","name":"dumpRaw","required":false,"schema":{"default":false,"title":"Dumpraw","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAQResult"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Locationsv1 Get","tags":["v1"]}},"/v1/measurements":{"get":{"operationId":"measurements_get_v1_v1_measurements_get","parameters":[{"in":"query","name":"format","required":false,"schema":{"title":"Format","type":"string"}},{"in":"query","name":"date_from","required":false,"schema":{"anyOf":[{"format":"date-time","type":"string"},{"format":"date","type":"string"}],"default":"2025-04-15T13:50:51.849Z","title":"Date From"}},{"in":"query","name":"date_to","required":false,"schema":{"anyOf":[{"format":"date-time","type":"string"},{"format":"date","type":"string"}],"default":"2025-04-15T13:50:51.849Z","title":"Date To"}},{"description":"Change the number of results returned.","in":"query","name":"limit","required":false,"schema":{"default":100,"description":"Change the number of results returned.","exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Limit","type":"integer"}},{"description":"Paginate through results.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Paginate through results.","exclusiveMinimum":true,"maximum":6000,"minimum":0,"title":"Page","type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":10000,"minimum":0,"title":"Offset","type":"integer"}},{"in":"query","name":"sort","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Sort"}],"default":"desc"}},{"in":"query","name":"has_geo","required":false,"schema":{"title":"Has Geo","type":"boolean"}},{"in":"query","name":"parameter_id","required":false,"schema":{"title":"Parameter Id","type":"integer"}},{"in":"query","name":"parameter","required":false,"schema":{"items":{"anyOf":[{"exclusiveMinimum":true,"maximum":2147483647,"minimum":0,"type":"integer"},{"type":"string"}]},"title":"Parameter","type":"array"}},{"in":"query","name":"unit","required":false,"schema":{"items":{"type":"string"},"title":"Unit","type":"array"}},{"in":"query","name":"coordinates","required":false,"schema":{"pattern":"^-?\\d{1,2}\\.?\\d{0,8},-?1?\\d{1,2}\\.?\\d{0,8}$","title":"Coordinates","type":"string"}},{"in":"query","name":"radius","required":false,"schema":{"default":1000,"exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Radius","type":"integer"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","in":"query","name":"country_id","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","title":"Country Id","type":"string"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","in":"query","name":"country","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","items":{"maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","type":"string"},"title":"Country","type":"array"}},{"description":"\n        Limit results by a certain city or cities.\n        (ex. ?city=Chicago or ?city=Chicago&city=Boston)\n        ","in":"query","name":"city","required":false,"schema":{"description":"\n        Limit results by a certain city or cities.\n        (ex. ?city=Chicago or ?city=Chicago&city=Boston)\n        ","items":{"type":"string"},"title":"City","type":"array"}},{"in":"query","name":"location_id","required":false,"schema":{"title":"Location Id","type":"integer"}},{"in":"query","name":"location","required":false,"schema":{"items":{"anyOf":[{"type":"integer"},{"type":"string"}]},"title":"Location","type":"array"}},{"in":"query","name":"order_by","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/MeasOrder"}],"default":"datetime"}},{"in":"query","name":"isMobile","required":false,"schema":{"title":"Ismobile","type":"boolean"}},{"in":"query","name":"isAnalysis","required":false,"schema":{"title":"Isanalysis","type":"boolean"}},{"in":"query","name":"project","required":false,"schema":{"title":"Project","type":"integer"}},{"in":"query","name":"entity","required":false,"schema":{"$ref":"#/components/schemas/EntityTypes"}},{"in":"query","name":"sensorType","required":false,"schema":{"$ref":"#/components/schemas/SensorTypes"}},{"in":"query","name":"value_from","required":false,"schema":{"title":"Value From","type":"number"}},{"in":"query","name":"value_to","required":false,"schema":{"title":"Value To","type":"number"}},{"in":"query","name":"include_fields","required":false,"schema":{"title":"Include Fields","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Measurements Get V1","tags":["v1"]}},"/v1/parameters":{"get":{"operationId":"parameters_getv1_v1_parameters_get","parameters":[{"description":"Change the number of results returned.","in":"query","name":"limit","required":false,"schema":{"default":100,"description":"Change the number of results returned.","exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Limit","type":"integer"}},{"description":"Paginate through results.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Paginate through results.","exclusiveMinimum":true,"maximum":6000,"minimum":0,"title":"Page","type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":10000,"minimum":0,"title":"Offset","type":"integer"}},{"description":"Define sort order.","in":"query","name":"sort","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Sort"}],"default":"asc","description":"Define sort order."}},{"in":"query","name":"sourceName","required":false,"schema":{"items":{"type":"string"},"title":"Sourcename","type":"array"}},{"in":"query","name":"sourceId","required":false,"schema":{"items":{"type":"integer"},"title":"Sourceid","type":"array"}},{"in":"query","name":"sourceSlug","required":false,"schema":{"items":{"type":"string"},"title":"Sourceslug","type":"array"}},{"in":"query","name":"order_by","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"string"},{"type":"string"}],"default":"id","title":"Order By"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAQParametersResult"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Parameters Getv1","tags":["v1"]}},"/v1/sources":{"get":{"operationId":"sources_v1_get_v1_sources_get","parameters":[{"description":"Change the number of results returned.","in":"query","name":"limit","required":false,"schema":{"default":100,"description":"Change the number of results returned.","exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Limit","type":"integer"}},{"description":"Paginate through results.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Paginate through results.","exclusiveMinimum":true,"maximum":6000,"minimum":0,"title":"Page","type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":10000,"minimum":0,"title":"Offset","type":"integer"}},{"description":"Define sort order.","in":"query","name":"sort","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Sort"}],"default":"asc","description":"Define sort order."}},{"in":"query","name":"name","required":false,"schema":{"title":"Name","type":"string"}},{"in":"query","name":"order_by","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/SourcesV1Order"}],"default":"name"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAQResult"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Sources V1 Get","tags":["v1"]}},"/v2/averages":{"get":{"operationId":"averages_v2_get_v2_averages_get","parameters":[{"in":"query","name":"date_from","required":false,"schema":{"anyOf":[{"format":"date-time","type":"string"},{"format":"date","type":"string"}],"default":"2025-04-15T13:50:51.849Z","title":"Date From"}},{"in":"query","name":"date_to","required":false,"schema":{"anyOf":[{"format":"date-time","type":"string"},{"format":"date","type":"string"}],"default":"2025-04-15T13:50:51.849Z","title":"Date To"}},{"in":"query","name":"parameter_id","required":false,"schema":{"title":"Parameter Id","type":"integer"}},{"in":"query","name":"parameter","required":false,"schema":{"items":{"anyOf":[{"exclusiveMinimum":true,"maximum":2147483647,"minimum":0,"type":"integer"},{"type":"string"}]},"title":"Parameter","type":"array"}},{"in":"query","name":"unit","required":false,"schema":{"items":{"type":"string"},"title":"Unit","type":"array"}},{"in":"query","name":"project_id","required":false,"schema":{"title":"Project Id","type":"integer"}},{"in":"query","name":"project","required":false,"schema":{"items":{"anyOf":[{"exclusiveMinimum":true,"maximum":2147483647,"minimum":0,"type":"integer"},{"type":"string"}]},"title":"Project","type":"array"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","in":"query","name":"country_id","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","title":"Country Id","type":"string"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","in":"query","name":"country","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","items":{"maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","type":"string"},"title":"Country","type":"array"}},{"description":"Change the number of results returned.","in":"query","name":"limit","required":false,"schema":{"default":100,"description":"Change the number of results returned.","exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Limit","type":"integer"}},{"description":"Paginate through results.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Paginate through results.","exclusiveMinimum":true,"maximum":6000,"minimum":0,"title":"Page","type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":10000,"minimum":0,"title":"Offset","type":"integer"}},{"description":"Define sort order.","in":"query","name":"sort","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Sort"}],"default":"desc","description":"Define sort order."}},{"in":"query","name":"spatial","required":true,"schema":{"$ref":"#/components/schemas/Spatial"}},{"in":"query","name":"temporal","required":true,"schema":{"$ref":"#/components/schemas/Temporal"}},{"in":"query","name":"location","required":false,"schema":{"items":{"type":"string"},"title":"Location","type":"array"}},{"in":"query","name":"group","required":false,"schema":{"default":false,"title":"Group","type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAQResult"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Averages V2 Get","tags":["v2"]}},"/v2/cities":{"get":{"operationId":"cities_get_v2_cities_get","parameters":[{"description":"Change the number of results returned.","in":"query","name":"limit","required":false,"schema":{"default":100,"description":"Change the number of results returned.","exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Limit","type":"integer"}},{"description":"Paginate through results.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Paginate through results.","exclusiveMinimum":true,"maximum":6000,"minimum":0,"title":"Page","type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":10000,"minimum":0,"title":"Offset","type":"integer"}},{"description":"Define sort order.","in":"query","name":"sort","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Sort"}],"default":"asc","description":"Define sort order."}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","in":"query","name":"country_id","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","title":"Country Id","type":"string"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","in":"query","name":"country","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","items":{"maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","type":"string"},"title":"Country","type":"array"}},{"description":"\n        Limit results by a certain city or cities.\n        (ex. ?city=Chicago or ?city=Chicago&city=Boston)\n        ","in":"query","name":"city","required":false,"schema":{"description":"\n        Limit results by a certain city or cities.\n        (ex. ?city=Chicago or ?city=Chicago&city=Boston)\n        ","items":{"type":"string"},"title":"City","type":"array"}},{"description":"Order by a field","in":"query","name":"order_by","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/CitiesOrder"}],"default":"city","description":"Order by a field"}},{"in":"query","name":"entity","required":false,"schema":{"title":"Entity","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAQCitiesResult"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Provides a simple listing of cities within the platform","tags":["v2"]}},"/v2/countries":{"get":{"operationId":"countries_get_v2_countries_get","parameters":[{"in":"query","name":"limit","required":false,"schema":{"default":200,"title":"Limit","type":"integer"}},{"description":"Paginate through results.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Paginate through results.","exclusiveMinimum":true,"maximum":6000,"minimum":0,"title":"Page","type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":10000,"minimum":0,"title":"Offset","type":"integer"}},{"description":"Define sort order.","in":"query","name":"sort","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Sort"}],"default":"asc","description":"Define sort order."}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","in":"query","name":"country_id","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","title":"Country Id","type":"string"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","in":"query","name":"country","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","items":{"maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","type":"string"},"title":"Country","type":"array"}},{"in":"query","name":"order_by","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/CountriesOrder"}],"default":"country"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAQCountriesResult"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Countries Get","tags":["v2"]}},"/v2/countries/{country_id}":{"get":{"operationId":"countries_get_v2_countries__country_id__get","parameters":[{"in":"path","name":"country_id","required":true,"schema":{"maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","title":"Country Id","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"default":200,"title":"Limit","type":"integer"}},{"description":"Paginate through results.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Paginate through results.","exclusiveMinimum":true,"maximum":6000,"minimum":0,"title":"Page","type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":10000,"minimum":0,"title":"Offset","type":"integer"}},{"description":"Define sort order.","in":"query","name":"sort","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Sort"}],"default":"asc","description":"Define sort order."}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","in":"query","name":"country","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. ?country=US or ?country=US&country=MX)\n        ","items":{"maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","type":"string"},"title":"Country","type":"array"}},{"in":"query","name":"order_by","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/CountriesOrder"}],"default":"country"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenAQCountriesResult"}}},"description":"Successful Response"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}},"description":"Validation Error"}},"summary":"Countries Get","tags":["v2"]}},"/v2/latest":{"get":{"operationId":"latest_get_v2_latest_get","parameters":[{"description":"Change the number of results returned.","in":"query","name":"limit","required":false,"schema":{"default":100,"description":"Change the number of results returned.","exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Limit","type":"integer"}},{"description":"Paginate through results.","in":"query","name":"page","required":false,"schema":{"default":1,"description":"Paginate through results.","exclusiveMinimum":true,"maximum":6000,"minimum":0,"title":"Page","type":"integer"}},{"in":"query","name":"offset","required":false,"schema":{"default":0,"maximum":10000,"minimum":0,"title":"Offset","type":"integer"}},{"description":"Sort Direction","in":"query","name":"sort","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/Sort"}],"default":"desc","description":"Sort Direction"}},{"in":"query","name":"has_geo","required":false,"schema":{"title":"Has Geo","type":"boolean"}},{"in":"query","name":"parameter_id","required":false,"schema":{"title":"Parameter Id","type":"integer"}},{"in":"query","name":"parameter","required":false,"schema":{"items":{"anyOf":[{"exclusiveMinimum":true,"maximum":2147483647,"minimum":0,"type":"integer"},{"type":"string"}]},"title":"Parameter","type":"array"}},{"in":"query","name":"unit","required":false,"schema":{"items":{"type":"string"},"title":"Unit","type":"array"}},{"in":"query","name":"coordinates","required":false,"schema":{"pattern":"^-?\\d{1,2}\\.?\\d{0,8},-?1?\\d{1,2}\\.?\\d{0,8}$","title":"Coordinates","type":"string"}},{"in":"query","name":"radius","required":false,"schema":{"default":1000,"exclusiveMinimum":true,"maximum":100000,"minimum":0,"title":"Radius","type":"integer"}},{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","in":"query","name":"country_id","required":false,"schema":{"description":"\n        Limit results by a certain country using two letter country code.\n        (ex. /US)\n        ","maxLength":2,"minLength":2,"pattern":"[a-zA-Z][a-zA-Z]","title":"Country Id","type":"string"}},{"description"