Skip to content
OpenAQ Docs

Get an instrument by ID

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

Provides a instrument by instrument ID

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
instruments_id
required
Instruments Id

Limit the results to a specific instruments id

integer

Limit the results to a specific instruments id

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
InstrumentsResponse
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>
Instrument
object
id
required
Id
integer
name
required
Name
string
isMonitor
required
Ismonitor
boolean
manufacturer
required
ManufacturerBase
object
id
required
Id
integer
name
required
Name
string
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"
    }
  ]
}