Skip to content
OpenAQ Docs

Get a location by ID

GET
/v3/locations/{locations_id}
 
curl --request GET \
  --url https://example.com/v3/locations/1 \
  --header 'X-API-Key: <X-API-Key>'

Provides a location by location ID

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
locations_id
required
Locations Id

Limit the results to a specific location by id

integer

Limit the results to a specific location by id

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
LocationsResponse
object
meta
Meta
object
name
Name
string
default: openaq-api
website
Website
string
default: /
page
Page
integer
default: 1
limit
Limit
integer
default: 100
found
Any of:
integer
results
required
Results
Array<object>
Location
object
id
required
Id
integer
name
Any of:
string
locality
Any of:
string
timezone
required
Timezone
string
country
required
CountryBase
object
id
Any of:
integer
code
required
Code
string
name
required
Name
string
owner
required
EntityBase
object
id
required
Id
integer
name
required
Name
string
provider
required
ProviderBase
object
id
required
Id
integer
name
required
Name
string
isMobile
required
Ismobile
boolean
isMonitor
required
Ismonitor
boolean
instruments
required
Instruments
Array<object>
InstrumentBase
object
id
required
Id
integer
name
required
Name
string
sensors
required
Sensors
Array<object>
SensorBase
object
id
required
Id
integer
name
required
Name
string
parameter
required
ParameterBase
object
id
required
Id
integer
name
required
Name
string
units
required
Units
string
displayName
Any of:
string
coordinates
required
Coordinates
object
latitude
Any of:
number
longitude
Any of:
number
licenses
Any of:
Array<object>
LocationLicense
object
id
required
Id
integer
name
required
Name
string
attribution
required
AttributionEntity
object
name
required
Name
string
url
Any of:
string
dateFrom
Any of:
string format: date
dateTo
Any of:
string format: date
bounds
required
Bounds
Array<number>
>= 4 items <= 4 items
distance
Any of:
number
datetimeFirst
Any of:
DatetimeObject
object
utc
required
Utc
string format: date-time
local
required
Local
string format: date-time
datetimeLast
Any of:
DatetimeObject
object
utc
required
Utc
string format: date-time
local
required
Local
string format: date-time
Example 
{
  "meta": {
    "name": "openaq-api",
    "website": "/",
    "page": 1,
    "limit": 100
  }
}

422

Section titled “422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}