Skip to content
OpenAQ Docs

Get instruments

GET
/v3/instruments
 
curl --request GET \
  --url 'https://example.com/v3/instruments?order_by=id&sort_order=asc&limit=100&page=1' \
  --header 'X-API-Key: <X-API-Key>'

Provides a list of instruments

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
order_by
Any of:
InstrumentsSortFields
string
Allowed values: id

The field by which to order results

sort_order
Any of:
SortOrder
string
Allowed values: asc desc

Sort results ascending or descending. Default ASC

limit
Limit

Change the number of results returned. e.g. limit=100 will return up to 100 results

integer
default: 100

Change the number of results returned. e.g. limit=100 will return up to 100 results

page
Page

Paginate through results. e.g. page=1 will return first page of results

integer
default: 1

Paginate through results. e.g. page=1 will return first page of results

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"
    }
  ]
}