CRUD, search, faving, quality metrics, stats, and more
swagger: '2.0'
info:
title: iNaturalist Annotations Observations API
description: '# https://api.inaturalist.org/v1/
[iNaturalist](https://www.inaturalist.org/) is a global community of
naturalists, scientists, and members of the public sharing over a million
wildlife sightings to teach one another about the natural world while
creating high quality citizen science data for science and conservation.
These API methods return data in JSON/JSONP and PNG response formats. They
are meant to supplement the existing [iNaturalist
API](https://www.inaturalist.org/pages/api+reference), implemented in Ruby
on Rails, which has more functionality and supports more write operations,
but tends to be slower and have less consistent response formats. Visit our
[developers page](https://www.inaturalist.org/pages/developers) for more
information. Write operations that expect and return JSON describe a single
`body` parameter that represents the request body, which should be specified
as JSON. See the "Model" of each body parameter for attributes that we
accept in these JSON objects.
Multiple values for a single URL parameter should be separated by commas,
e.g. `taxon_id=1,2,3`.
Map tiles are generated using the
[node-mapnik](https://github.com/mapnik/node-mapnik) library, following the
XYZ map tiling scheme. The "Observation Tile" methods accept nearly all the
parameters of the observation search APIs, and will generate map tiles
reflecting the same observations returned by searches. These
"Observation Tile" methods have corresponding
[UTFGrid](https://github.com/mapbox/utfgrid-spec) JSON
responses which return information needed to make interactive maps.
Authentication in the Node API is handled via JSON Web Tokens (JWT). To
obtain one, make an [OAuth-authenticated
request](http://www.inaturalist.org/pages/api+reference#auth) to
https://www.inaturalist.org/users/api_token. Each JWT will expire after 24
hours. Authentication required for all PUT and POST requests. Some GET
requests will also include private information like hidden coordinates if
the authenticated user has permission to view them.
Photos served from https://static.inaturalist.org and
https://inaturalist-open-data.s3.amazonaws.com have multiple size
variants and not all size variants are returned in responses. To access
other sizes, the photo URL can be modified to replace only the size
qualifier (each variant shares the exact same extension). The domain a photo
is hosted under reflects the license under which the photo is being shared,
and the domain may change over time if the license changes. Photos in
the `inaturalist-open-data` domain are shared under open licenses. These can
be accessed in bulk in the [iNaturalist AWS Open Dataset](
https://registry.opendata.aws/inaturalist-open-data/). Photos in the
`static.inaturalist.org` domain do not have open licenses.
The available photo sizes are:
* original (max 2048px in either dimension)
* large (max 1024px in either dimension)
* medium (max 500px in either dimension)
* small (max 240px in either dimension)
* thumb (max 100px in either dimension)
* square (75px square)
iNaturalist Website: https://www.inaturalist.org/
Open Source Software: https://github.com/inaturalist/
## Terms of Use
Use of this API is subject to the iNaturalist
[Terms of Service](https://www.inaturalist.org/terms) and
[Privacy Policy](https://www.inaturalist.org/privacy). We will block any
use of our API that violates our Terms or Privacy Policy without notice.
The API is intended to support application development, not data scraping.
For pre- generated data exports, see
https://www.inaturalist.org/pages/developers.
Please note that we throttle API usage to a max of 100 requests per minute,
though we ask that you try to keep it to 60 requests per minute or lower,
and to keep under 10,000 requests per day. If we notice usage that has
serious impact on our performance we may institute blocks without
notification.
Terms of Service: https://www.inaturalist.org/terms
Privacy Policy: https://www.inaturalist.org/privacy
'
version: 1.3.0
basePath: /v1
schemes:
- http
- https
produces:
- application/json
tags:
- name: Observations
description: CRUD, search, faving, quality metrics, stats, and more
paths:
/observations/{id}:
get:
summary: Observation Details
description: 'Given an ID, or an array of IDs in comma-delimited format, returns
corresponding observations. A maximum of 200 results will be returned
'
parameters:
- $ref: '#/parameters/path_multi_id'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: 'Returns an object with metadata and an array of observations
'
schema:
$ref: '#/definitions/ObservationsShowResponse'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
put:
summary: Observation Update
description: 'Update an observation
'
consumes:
- application/json
parameters:
- $ref: '#/parameters/path_id'
- name: body
in: body
description: Comment object
schema:
$ref: '#/definitions/PostObservation'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: OK
delete:
summary: Observation Delete
description: 'Delete an observation
'
parameters:
- $ref: '#/parameters/path_id'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: OK
/observations/{id}/fave:
post:
summary: Observations Fave
description: 'Fave an observation
'
parameters:
- $ref: '#/parameters/path_id'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: OK
/observations/{id}/unfave:
delete:
summary: Observations Unfave
description: 'Unfave an observation
'
parameters:
- $ref: '#/parameters/path_id'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: OK
/observations/{id}/review:
post:
summary: Observations Review
description: 'Review an observation
'
parameters:
- $ref: '#/parameters/path_id'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: OK
delete:
summary: Observations Unreview
description: 'Unreview an observation
'
parameters:
- $ref: '#/parameters/path_id'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: OK
/observations/{id}/subscriptions:
get:
summary: Observation Subscriptions
description: 'Fetches any subscriptions the current user has to this observation
or the observer
'
parameters:
- $ref: '#/parameters/path_id'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: OK
/observations/{id}/quality/{metric}:
post:
summary: Quality Metric Set
description: 'Set the value of a quality metric
'
parameters:
- $ref: '#/parameters/path_id'
- $ref: '#/parameters/path_metric'
- name: body
in: body
description: Quality object
schema:
$ref: '#/definitions/PostQuality'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: OK
delete:
summary: Quality Metric Delete
description: 'Delete a quality metric
'
consumes:
- application/x-www-form-urlencoded
parameters:
- $ref: '#/parameters/path_id'
- $ref: '#/parameters/path_metric'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: OK
/observations/{id}/taxon_summary:
get:
summary: Observation Taxon Summary
description: 'Fetches information about this observation''s taxon, within the context
of this observation''s location
'
parameters:
- $ref: '#/parameters/path_id'
tags:
- Observations
responses:
'200':
description: OK
/subscriptions/observation/{id}/subscribe:
post:
summary: Observation Subscribe
description: 'Toggles current user''s subscription to this observation. If the logged-in
user is not subscribed, POSTing here will subscribe them. If they are already
subscribed, this will remove the subscription
'
parameters:
- $ref: '#/parameters/path_id'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: OK
/votes/vote/observation/{id}:
post:
summary: Observation Vote
description: 'Vote on an observation. A vote with an empty `scope` is recorded as a
`fave` of the observation. A vote with scope `needs_id` is recorded as a
vote on the Quality Grade criterion "can the Community ID still be
confirmed or improved?", and can be an up or down vote
'
parameters:
- $ref: '#/parameters/path_id'
- name: body
in: body
description: Vote object
schema:
$ref: '#/definitions/PostObservationVote'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: OK
/votes/unvote/observation/{id}:
delete:
summary: Observation Unvote
description: Remove a vote from an observation
parameters:
- $ref: '#/parameters/path_id'
- name: body
in: body
description: Vote object
schema:
$ref: '#/definitions/PostObservationVote'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: OK
/observations:
get:
summary: Observation Search
description: 'Given zero to many of following parameters, returns observations
matching the search criteria. The large size of the observations index
prevents us from supporting the `page` parameter when retrieving records
from large result sets. If you need to retrieve large numbers of
records, use the `per_page` and `id_above` or `id_below` parameters
instead.
'
parameters:
- $ref: '#/parameters/acc'
- $ref: '#/parameters/captive'
- $ref: '#/parameters/endemic'
- $ref: '#/parameters/geo'
- $ref: '#/parameters/id_please'
- $ref: '#/parameters/identified'
- $ref: '#/parameters/introduced'
- $ref: '#/parameters/mappable'
- $ref: '#/parameters/native'
- $ref: '#/parameters/out_of_range'
- $ref: '#/parameters/pcid'
- $ref: '#/parameters/photos'
- $ref: '#/parameters/popular'
- $ref: '#/parameters/sounds'
- $ref: '#/parameters/taxon_is_active'
- $ref: '#/parameters/threatened'
- $ref: '#/parameters/verifiable'
- $ref: '#/parameters/licensed'
- $ref: '#/parameters/photo_licensed'
- $ref: '#/parameters/expected_nearby'
- $ref: '#/parameters/id'
- $ref: '#/parameters/not_id'
- $ref: '#/parameters/license'
- $ref: '#/parameters/ofv_datatype'
- $ref: '#/parameters/photo_license'
- $ref: '#/parameters/place_id'
- $ref: '#/parameters/project_id'
- $ref: '#/parameters/rank'
- $ref: '#/parameters/site_id'
- $ref: '#/parameters/sound_license'
- $ref: '#/parameters/taxon_id'
- $ref: '#/parameters/without_taxon_id'
- $ref: '#/parameters/taxon_name'
- $ref: '#/parameters/user_id'
- $ref: '#/parameters/user_login'
- $ref: '#/parameters/ident_user_id'
- $ref: '#/parameters/hour'
- $ref: '#/parameters/day'
- $ref: '#/parameters/month'
- $ref: '#/parameters/year'
- $ref: '#/parameters/created_day'
- $ref: '#/parameters/created_month'
- $ref: '#/parameters/created_year'
- $ref: '#/parameters/term_id'
- $ref: '#/parameters/term_value_id'
- $ref: '#/parameters/without_term_id'
- $ref: '#/parameters/without_term_value_id'
- $ref: '#/parameters/term_id_or_unknown'
- $ref: '#/parameters/annotation_user_id'
- $ref: '#/parameters/acc_above'
- $ref: '#/parameters/acc_below'
- $ref: '#/parameters/acc_below_or_unknown'
- $ref: '#/parameters/d1'
- $ref: '#/parameters/d2'
- $ref: '#/parameters/created_d1'
- $ref: '#/parameters/created_d2'
- $ref: '#/parameters/created_on'
- $ref: '#/parameters/observed_on'
- $ref: '#/parameters/unobserved_by_user_id'
- $ref: '#/parameters/apply_project_rules_for'
- $ref: '#/parameters/cs'
- $ref: '#/parameters/csa'
- $ref: '#/parameters/csi'
- $ref: '#/parameters/geoprivacy'
- $ref: '#/parameters/taxon_geoprivacy'
- $ref: '#/parameters/obscuration'
- $ref: '#/parameters/hrank'
- $ref: '#/parameters/lrank'
- $ref: '#/parameters/iconic_taxa'
- $ref: '#/parameters/id_above'
- $ref: '#/parameters/id_below'
- $ref: '#/parameters/identifications'
- $ref: '#/parameters/lat'
- $ref: '#/parameters/lng'
- $ref: '#/parameters/radius'
- $ref: '#/parameters/nelat'
- $ref: '#/parameters/nelng'
- $ref: '#/parameters/swlat'
- $ref: '#/parameters/swlng'
- $ref: '#/parameters/list_id'
- $ref: '#/parameters/not_in_project'
- $ref: '#/parameters/not_matching_project_rules_for'
- $ref: '#/parameters/observation_accuracy_experiment_id'
- $ref: '#/parameters/fails_dqa_accurate'
- $ref: '#/parameters/fails_dqa_date'
- $ref: '#/parameters/fails_dqa_evidence'
- $ref: '#/parameters/fails_dqa_location'
- $ref: '#/parameters/fails_dqa_needs_id'
- $ref: '#/parameters/fails_dqa_recent'
- $ref: '#/parameters/fails_dqa_subject'
- $ref: '#/parameters/fails_dqa_wild'
- $ref: '#/parameters/q'
- $ref: '#/parameters/search_on'
- $ref: '#/parameters/quality_grade'
- $ref: '#/parameters/updated_since'
- $ref: '#/parameters/viewer_id'
- $ref: '#/parameters/reviewed'
- $ref: '#/parameters/locale'
- $ref: '#/parameters/preferred_place_id'
- $ref: '#/parameters/ttl'
- $ref: '#/parameters/page'
- $ref: '#/parameters/per_page'
- $ref: '#/parameters/order'
- $ref: '#/parameters/order_by'
- $ref: '#/parameters/only_id'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: 'Returns an object with metadata and an array of observations
'
schema:
$ref: '#/definitions/ObservationsResponse'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
post:
summary: Observation Create
description: 'Create an observation
'
consumes:
- application/json
parameters:
- name: body
in: body
description: Comment object
schema:
$ref: '#/definitions/PostObservation'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: OK
/observations/deleted:
get:
summary: Observations Deleted
description: 'Given a starting date, return an array of IDs of the authenticated
user''s observations that have been deleted since that date. Requires
authentication
'
parameters:
- $ref: '#/parameters/since'
tags:
- Observations
security:
- api_token: []
responses:
'200':
description: OK
/observations/histogram:
get:
summary: Observation Histogram
description: 'Given zero to many of following parameters, returns histogram data about
observations matching the search criteria
'
parameters:
- $ref: '#/parameters/acc'
- $ref: '#/parameters/captive'
- $ref: '#/parameters/endemic'
- $ref: '#/parameters/geo'
- $ref: '#/parameters/id_please'
- $ref: '#/parameters/identified'
- $ref: '#/parameters/introduced'
- $ref: '#/parameters/mappable'
- $ref: '#/parameters/native'
- $ref: '#/parameters/out_of_range'
- $ref: '#/parameters/pcid'
- $ref: '#/parameters/photos'
- $ref: '#/parameters/popular'
- $ref: '#/parameters/sounds'
- $ref: '#/parameters/taxon_is_active'
- $ref: '#/parameters/threatened'
- $ref: '#/parameters/verifiable'
- $ref: '#/parameters/licensed'
- $ref: '#/parameters/photo_licensed'
- $ref: '#/parameters/expected_nearby'
- $ref: '#/parameters/id'
- $ref: '#/parameters/not_id'
- $ref: '#/parameters/license'
- $ref: '#/parameters/ofv_datatype'
- $ref: '#/parameters/photo_license'
- $ref: '#/parameters/place_id'
- $ref: '#/parameters/project_id'
- $ref: '#/parameters/rank'
- $ref: '#/parameters/site_id'
- $ref: '#/parameters/sound_license'
- $ref: '#/parameters/taxon_id'
- $ref: '#/parameters/without_taxon_id'
- $ref: '#/parameters/taxon_name'
- $ref: '#/parameters/user_id'
- $ref: '#/parameters/user_login'
- $ref: '#/parameters/ident_user_id'
- $ref: '#/parameters/hour'
- $ref: '#/parameters/day'
- $ref: '#/parameters/month'
- $ref: '#/parameters/year'
- $ref: '#/parameters/created_day'
- $ref: '#/parameters/created_month'
- $ref: '#/parameters/created_year'
- $ref: '#/parameters/term_id'
- $ref: '#/parameters/term_value_id'
- $ref: '#/parameters/without_term_id'
- $ref: '#/parameters/without_term_value_id'
- $ref: '#/parameters/term_id_or_unknown'
- $ref: '#/parameters/annotation_user_id'
- $ref: '#/parameters/acc_above'
- $ref: '#/parameters/acc_below'
- $ref: '#/parameters/acc_below_or_unknown'
- $ref: '#/parameters/d1'
- $ref: '#/parameters/d2'
- $ref: '#/parameters/created_d1'
- $ref: '#/parameters/created_d2'
- $ref: '#/parameters/created_on'
- $ref: '#/parameters/observed_on'
- $ref: '#/parameters/unobserved_by_user_id'
- $ref: '#/parameters/apply_project_rules_for'
- $ref: '#/parameters/cs'
- $ref: '#/parameters/csa'
- $ref: '#/parameters/csi'
- $ref: '#/parameters/geoprivacy'
- $ref: '#/parameters/taxon_geoprivacy'
- $ref: '#/parameters/obscuration'
- $ref: '#/parameters/hrank'
- $ref: '#/parameters/lrank'
- $ref: '#/parameters/iconic_taxa'
- $ref: '#/parameters/id_above'
- $ref: '#/parameters/id_below'
- $ref: '#/parameters/identifications'
- $ref: '#/parameters/lat'
- $ref: '#/parameters/lng'
- $ref: '#/parameters/radius'
- $ref: '#/parameters/nelat'
- $ref: '#/parameters/nelng'
- $ref: '#/parameters/swlat'
- $ref: '#/parameters/swlng'
- $ref: '#/parameters/list_id'
- $ref: '#/parameters/not_in_project'
- $ref: '#/parameters/not_matching_project_rules_for'
- $ref: '#/parameters/observation_accuracy_experiment_id'
- $ref: '#/parameters/fails_dqa_accurate'
- $ref: '#/parameters/fails_dqa_date'
- $ref: '#/parameters/fails_dqa_evidence'
- $ref: '#/parameters/fails_dqa_location'
- $ref: '#/parameters/fails_dqa_needs_id'
- $ref: '#/parameters/fails_dqa_recent'
- $ref: '#/parameters/fails_dqa_subject'
- $ref: '#/parameters/fails_dqa_wild'
- $ref: '#/parameters/q'
- $ref: '#/parameters/search_on'
- $ref: '#/parameters/quality_grade'
- $ref: '#/parameters/updated_since'
- $ref: '#/parameters/viewer_id'
- $ref: '#/parameters/reviewed'
- $ref: '#/parameters/locale'
- $ref: '#/parameters/preferred_place_id'
- $ref: '#/parameters/ttl'
- $ref: '#/parameters/date_field'
- $ref: '#/parameters/interval'
tags:
- Observations
responses:
'200':
description: 'Returns an object with metadata and an array of histogram data
'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/observations/identifiers:
get:
summary: Observation Identifiers
description: 'Given zero to many of following parameters, returns identifiers of
observations matching the search criteria and the count of
observations they have identified, ordered by count descending. A
maximum of 500 results will be returned
'
parameters:
- $ref: '#/parameters/acc'
- $ref: '#/parameters/captive'
- $ref: '#/parameters/endemic'
- $ref: '#/parameters/geo'
- $ref: '#/parameters/id_please'
- $ref: '#/parameters/identified'
- $ref: '#/parameters/introduced'
- $ref: '#/parameters/mappable'
- $ref: '#/parameters/native'
- $ref: '#/parameters/out_of_range'
- $ref: '#/parameters/pcid'
- $ref: '#/parameters/photos'
- $ref: '#/parameters/popular'
- $ref: '#/parameters/sounds'
- $ref: '#/parameters/taxon_is_active'
- $ref: '#/parameters/threatened'
- $ref: '#/parameters/verifiable'
- $ref: '#/parameters/licensed'
- $ref: '#/parameters/photo_licensed'
- $ref: '#/parameters/expected_nearby'
- $ref: '#/parameters/id'
- $ref: '#/parameters/not_id'
- $ref: '#/parameters/license'
- $ref: '#/parameters/ofv_datatype'
- $ref: '#/parameters/photo_license'
- $ref: '#/parameters/place_id'
- $ref: '#/parameters/project_id'
- $ref: '#/parameters/rank'
- $ref: '#/parameters/site_id'
- $ref: '#/parameters/sound_license'
- $ref: '#/parameters/taxon_id'
- $ref: '#/parameters/without_taxon_id'
- $ref: '#/parameters/taxon_name'
- $ref: '#/parameters/user_id'
- $ref: '#/parameters/user_login'
- $ref: '#/parameters/ident_user_id'
- $ref: '#/parameters/hour'
- $ref: '#/parameters/day'
- $ref: '#/parameters/month'
- $ref: '#/parameters/year'
- $ref: '#/parameters/created_day'
- $ref: '#/parameters/created_month'
- $ref: '#/parameters/created_year'
- $ref: '#/parameters/term_id'
- $ref: '#/parameters/term_value_id'
- $ref: '#/parameters/without_term_id'
- $ref: '#/parameters/without_term_value_id'
- $ref: '#/parameters/term_id_or_unknown'
- $ref: '#/parameters/annotation_user_id'
- $ref: '#/parameters/acc_above'
- $ref: '#/parameters/acc_below'
- $ref: '#/parameters/acc_below_or_unknown'
- $ref: '#/parameters/d1'
- $ref: '#/parameters/d2'
- $ref: '#/parameters/created_d1'
- $ref: '#/parameters/created_d2'
- $ref: '#/parameters/created_on'
- $ref: '#/parameters/observed_on'
- $ref: '#/parameters/unobserved_by_user_id'
- $ref: '#/parameters/apply_project_rules_for'
- $ref: '#/parameters/cs'
- $ref: '#/parameters/csa'
- $ref: '#/parameters/csi'
- $ref: '#/parameters/geoprivacy'
- $ref: '#/parameters/taxon_geoprivacy'
- $ref: '#/parameters/obscuration'
- $ref: '#/parameters/hrank'
- $ref: '#/parameters/lrank'
- $ref: '#/parameters/iconic_taxa'
- $ref: '#/parameters/id_above'
- $ref: '#/parameters/id_below'
- $ref: '#/parameters/identifications'
- $ref: '#/parameters/lat'
- $ref: '#/parameters/lng'
- $ref: '#/parameters/radius'
- $ref: '#/parameters/nelat'
- $ref: '#/parameters/nelng'
- $ref: '#/parameters/swlat'
- $ref: '#/parameters/swlng'
- $ref: '#/parameters/list_id'
- $ref: '#/parameters/not_in_project'
- $ref: '#/parameters/not_matching_project_rules_for'
- $ref: '#/parameters/observation_accuracy_experiment_id'
- $ref: '#/parameters/fails_dqa_accurate'
- $ref: '#/parameters/fails_dqa_date'
- $ref: '#/parameters/fails_dqa_evidence'
- $ref: '#/parameters/fails_dqa_location'
- $ref: '#/parameters/fails_dqa_needs_id'
- $ref: '#/parameters/fails_dqa_recent'
- $ref: '#/parameters/fails_dqa_subject'
- $ref: '#/parameters/fails_dqa_wild'
- $ref: '#/parameters/q'
- $ref: '#/parameters/search_on'
- $ref: '#/parameters/quality_grade'
- $ref: '#/parameters/updated_since'
- $ref: '#/parameters/viewer_id'
- $ref: '#/parameters/reviewed'
- $ref: '#/parameters/locale'
- $ref: '#/parameters/preferred_place_id'
- $ref: '#/parameters/ttl'
tags:
- Observations
responses:
'200':
description: 'Returns an object with metadata and an array of identifiers
'
schema:
$ref: '#/definitions/UserCountsResponse'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/observations/observers:
get:
summary: Observation Observers
description: 'Given zero to many of following parameters, returns observers of
observations matching the search criteria and the count of
observations and distinct taxa of rank `species` they have observed. A
maximum of 500 results will be returned
'
parameters:
- $ref: '#/parameters/acc'
- $ref: '#/parameters/captive'
- $ref: '#/parameters/endemic'
- $ref: '#/parameters/geo'
- $ref: '#/parameters/id_please'
- $ref: '#/parameters/identified'
- $ref: '#/parameters/introduced'
- $ref: '#/parameters/mappable'
- $ref: '#/parameters/native'
- $ref: '#/parameters/out_of_range'
- $ref: '#/parameters/pcid'
- $ref: '#/parameters/photos'
- $ref: '#/parameters/popular'
- $ref: '#/parameters/sounds'
- $ref: '#/parameters/taxon_is_active'
- $ref: '#/parameters/threatened'
- $ref: '#/parameters/verifiable'
- $ref: '#/parameters/licensed'
- $ref: '#/parameters/photo_licensed'
- $ref: '#/parameters/expected_nearby'
- $ref: '#/parameters/id'
- $ref: '#/parameters/not_id'
- $ref: '#/parameters/license'
- $ref: '#/parameters/ofv_datatype'
- $ref: '#/parameters/photo_license'
- $ref: '#/parameters/place_id'
- $ref: '#/parameters/project_id'
- $ref: '#/parameters/rank'
- $ref: '#/parameters/site_id'
- $ref: '#/parameters/sound_license'
- $ref: '#/parameters/taxon_id'
- $ref: '#/parameters/without_taxon_id'
- $ref: '#/parameters/taxon_name'
- $ref: '#/parameters/user_id'
- $ref: '#/parameters/user_login'
- $ref: '#/parameters/ident_user_id'
- $ref: '#/parameters/hour'
- $ref: '#/parameters/day'
- $ref: '#/parameters/month'
- $ref: '#/parameters/year'
- $ref: '#/parameters/created_day'
- $ref: '#/parameters/created_month'
- $ref: '#/parameters/created_year'
- $ref: '#/parameters/term_id'
- $ref: '#/parameters/term_value_id'
- $ref: '#/parameters/without_term_id'
- $ref: '#/parameters/without_term_value_id'
- $ref: '#/parameters/term_id_or_unknown'
- $ref: '#/parameters/annotation_user_id'
- $ref: '#/parameters/acc_above'
- $ref: '#/parameters/acc_below'
- $ref: '#/parameters/acc_below_or_unknown'
- $ref: '#/parameters/d1'
- $ref: '#/parameters/d2'
- $ref: '#/parameters/created_d1'
- $ref: '#/parameters/created_d2'
- $ref: '#/parameters/created_on'
- $ref: '#/parameters/observed_on'
- $ref: '#/parameters/unobserved_by_user_id'
- $ref: '#/parameters/apply_project_rules_for'
- $ref: '#/parameters/cs'
- $ref: '#/parameters/csa'
- $ref: '#/parameters/csi'
- $ref: '#/parameters/geoprivacy'
- $ref: '#/parameters/taxon_geoprivacy'
- $ref: '#/parameters/obscuration'
- $ref: '#/parameters/hrank'
- $ref: '#/parameters/lrank'
- $ref: '#/parameters/iconic_taxa'
- $ref: '#/parameters/id_above'
- $ref: '#/parameters/id_below'
- $ref: '#/parameters/identifications'
- $ref: '#/parameters/lat'
- $ref: '#/parameters/lng'
- $ref: '#/parameters/radius'
- $ref: '#/parameters/nelat'
- $ref: '#/parameters/nelng'
- $ref: '#/parameters/swlat'
- $ref: '#/parameters/swlng'
- $ref: '#/parameters/list_id'
- $ref: '#/parameters/not_in_project'
- $ref: '#/parameters/not_matching_project_rules_for'
- $ref: '#/parameters/observation_accuracy_experiment_id'
- $ref: '#/parameters/fails_dqa_accurate'
- $ref: '#/parameters/fails_dqa_date'
- $ref: '#/parameters/fails_dqa_evidence'
- $ref: '#/parameters/fails_dqa_location'
- $ref: '#/parameters/fails_dqa_needs_id'
- $ref: '#/parameters/fails_dqa_recent'
- $ref: '#/parameters/fails_dqa_subject'
- $ref: '#/parameters/fails_dqa_wild'
- $ref: '#/parameters/q'
- $ref: '#/parameters/search_on'
- $ref: '#/parameters/quality_grade'
- $ref: '#/parameters/updated_since'
- $ref: '#/parameters/viewer_id'
- $ref: '#/parameters/reviewed'
- $ref: '#/parameters/locale'
- $ref: '#/parameters/preferred_place_id'
- $ref: '#/parameters/ttl'
tags:
- Observations
responses:
'200':
description: 'Returns an object with metadata and an array of observers
'
schema:
$ref: '#/definitions/ObservationsObserversResponse'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/observations/popular_field_values:
get:
summary: Observation Popular Field Values
description: 'Given zero to many of following parameters, returns an array of
relevant controlled terms values and a monthly histogram
'
parameters:
- $ref: '#/parameters/acc'
- $ref: '#/parameters/captive'
- $ref: '#/parameters/endemic'
- $ref: '#/parameters/geo'
- $ref: '#/parameters/id_please'
- $ref: '#/parameters/identified'
- $ref: '#/parameters/introduced'
- $ref: '#/parameters/mappable'
- $ref: '#/parameters/native'
- $ref: '#/parameters/out_of_range'
- $ref: '#/parameters/pcid'
- $ref: '#/parameters/photos'
- $ref: '#/parameters/popular'
- $ref: '#/parameters/sounds'
- $ref: '#/parameters/taxon_is_active'
- $ref: '#/parameters/threatened'
- $ref: '#/parameters/verifiable'
- $ref: '#/parameters/licensed'
- $ref: '#/parameters/photo_licensed'
- $ref: '#/parameters/expected_nearby'
- $ref: '#/parameters/id'
- $ref: '#/parameters/not_id'
- $ref: '#/parameters/license'
- $ref: '#/parameters/ofv_datatype'
- $ref: '#/parameters/photo_license'
- $ref: '#/parameters/place_id'
- $ref: '#/parameters/project_id'
- $ref: '#/parameters/rank'
- $ref: '#/parameters/site_id'
- $ref: '#/parameters/sound_license'
- $ref: '#/parameters/taxon_id'
- $ref: '#/parameters/without_taxon_id'
- $ref: '#/parameters/taxon_name'
- $ref: '#/parameters/user_id'
- $ref: '#/parameters/user_login'
- $ref: '#/parameters/ident_user_id'
- $ref: '#/parameters/hour'
- $ref: '#/parameters/day'
- $ref: '#/parameters/month'
- $ref: '#/parameters/year'
- $ref: '#/parameters/created_day'
- $ref: '#/parameters/created_month'
- $ref: '#/parameters/created_year'
- $ref: '#/parameters/term_id'
- $ref: '#/parameters/term_value_id'
- $ref: '#/parameters/without_term_id'
-
# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/inaturalist/refs/heads/main/openapi/inaturalist-observations-api-openapi.yml