Documentation
Documentation
https://www.inaturalist.org/pages/api+reference
RateLimits
https://raw.githubusercontent.com/api-evangelist/inaturalist/main/rate-limits/rate-limits.yml
OpenAPI Specification
swagger: '2.0'
info:
title: iNaturalist Annotations Identifications 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: Identifications
description: Create, update, and delete
paths:
/identifications/{id}:
get:
summary: Identification Details
description: 'Given an ID, or an array of IDs in comma-delimited format, returns
corresponding identifications. A maximum of 30 results will be returned
'
consumes:
- application/json
parameters:
- $ref: '#/parameters/path_multi_id'
tags:
- Identifications
responses:
'200':
description: OK
put:
summary: Identification Update
description: 'Update an identification. Note that to "withdraw" an observation you
send a `PUT` request to this endpoint and set the `current`
attribute to false. To "restore" it you do the same but set
`current` to `true`. Only one identification by a given user can be
`current` for a given observation, so if you "restore" one all the other
identifications by the authenticated user for the given observation will
be withdrawn.
'
consumes:
- application/json
parameters:
- $ref: '#/parameters/path_id'
- name: body
in: body
description: Identification object
schema:
$ref: '#/definitions/PostIdentification'
tags:
- Identifications
security:
- api_token: []
responses:
'200':
description: OK
delete:
summary: Identification Delete
description: 'Delete an identification. See description of `PUT /identifications/{id}
for notes on withdrawing and restoring identifications.
'
parameters:
- $ref: '#/parameters/path_id'
tags:
- Identifications
security:
- api_token: []
responses:
'200':
description: OK
/identifications:
post:
summary: Identification Create
description: Create an identification
consumes:
- application/json
parameters:
- name: body
in: body
description: Identification object
schema:
$ref: '#/definitions/PostIdentification'
tags:
- Identifications
security:
- api_token: []
responses:
'200':
description: OK
get:
summary: Identification Search
description: 'Given zero to many of following parameters, returns identifications
matching the search criteria
'
parameters:
- $ref: '#/parameters/ids_current_taxon'
- $ref: '#/parameters/ids_own_observation'
- $ref: '#/parameters/ids_is_change'
- $ref: '#/parameters/ids_taxon_active'
- $ref: '#/parameters/ids_observation_taxon_active'
- $ref: '#/parameters/ids_id'
- $ref: '#/parameters/ids_rank'
- $ref: '#/parameters/ids_observation_rank'
- $ref: '#/parameters/ids_user_id'
- $ref: '#/parameters/ids_user_login'
- $ref: '#/parameters/ids_current'
- $ref: '#/parameters/ids_category'
- $ref: '#/parameters/ids_place_id'
- $ref: '#/parameters/ids_quality_grade'
- $ref: '#/parameters/ids_taxon_change_id'
- $ref: '#/parameters/ids_taxon_id'
- $ref: '#/parameters/ids_observation_taxon_id'
- $ref: '#/parameters/ids_iconic_taxon_id'
- $ref: '#/parameters/ids_observation_iconic_taxon_id'
- $ref: '#/parameters/ids_lrank'
- $ref: '#/parameters/ids_hrank'
- $ref: '#/parameters/ids_observation_lrank'
- $ref: '#/parameters/ids_observation_hrank'
- $ref: '#/parameters/ids_without_taxon_id'
- $ref: '#/parameters/ids_without_observation_taxon_id'
- $ref: '#/parameters/ids_d1'
- $ref: '#/parameters/ids_d2'
- $ref: '#/parameters/ids_observation_created_d1'
- $ref: '#/parameters/ids_observation_created_d2'
- $ref: '#/parameters/ids_observed_d1'
- $ref: '#/parameters/ids_observed_d2'
- $ref: '#/parameters/id_above'
- $ref: '#/parameters/id_below'
- $ref: '#/parameters/page'
- $ref: '#/parameters/per_page'
- $ref: '#/parameters/order'
- $ref: '#/parameters/ids_order_by'
- $ref: '#/parameters/only_id'
tags:
- Identifications
responses:
'200':
description: OK
/identifications/categories:
get:
summary: Identification Categories
description: 'Given zero to many of following parameters, return counts of the
categories of identifications matching the search criteria
'
parameters:
- $ref: '#/parameters/ids_current_taxon'
- $ref: '#/parameters/ids_own_observation'
- $ref: '#/parameters/ids_is_change'
- $ref: '#/parameters/ids_taxon_active'
- $ref: '#/parameters/ids_observation_taxon_active'
- $ref: '#/parameters/ids_id'
- $ref: '#/parameters/ids_rank'
- $ref: '#/parameters/ids_observation_rank'
- $ref: '#/parameters/ids_user_id'
- $ref: '#/parameters/ids_user_login'
- $ref: '#/parameters/ids_current'
- $ref: '#/parameters/ids_category'
- $ref: '#/parameters/ids_place_id'
- $ref: '#/parameters/ids_quality_grade'
- $ref: '#/parameters/ids_taxon_change_id'
- $ref: '#/parameters/ids_taxon_id'
- $ref: '#/parameters/ids_observation_taxon_id'
- $ref: '#/parameters/ids_iconic_taxon_id'
- $ref: '#/parameters/ids_observation_iconic_taxon_id'
- $ref: '#/parameters/ids_lrank'
- $ref: '#/parameters/ids_hrank'
- $ref: '#/parameters/ids_observation_lrank'
- $ref: '#/parameters/ids_observation_hrank'
- $ref: '#/parameters/ids_without_taxon_id'
- $ref: '#/parameters/ids_without_observation_taxon_id'
- $ref: '#/parameters/ids_d1'
- $ref: '#/parameters/ids_d2'
- $ref: '#/parameters/ids_observation_created_d1'
- $ref: '#/parameters/ids_observation_created_d2'
- $ref: '#/parameters/ids_observed_d1'
- $ref: '#/parameters/ids_observed_d2'
- $ref: '#/parameters/id_above'
- $ref: '#/parameters/id_below'
- $ref: '#/parameters/page'
- $ref: '#/parameters/per_page'
- $ref: '#/parameters/order'
- $ref: '#/parameters/ids_order_by'
- $ref: '#/parameters/only_id'
tags:
- Identifications
responses:
'200':
description: OK
/identifications/species_counts:
get:
summary: Identification Species Counts
description: 'Given zero to many of following parameters, returns `leaf taxa`
associated with identifications matching the search criteria and the
count of identifications they are associated with, ordered by count
descending. `Leaf taxa` are the leaves of the taxonomic tree containing
only the taxa associated with observations matching the search criteria.
'
parameters:
- $ref: '#/parameters/ids_current_taxon'
- $ref: '#/parameters/ids_own_observation'
- $ref: '#/parameters/ids_is_change'
- $ref: '#/parameters/ids_taxon_active'
- $ref: '#/parameters/ids_observation_taxon_active'
- $ref: '#/parameters/ids_id'
- $ref: '#/parameters/ids_rank'
- $ref: '#/parameters/ids_observation_rank'
- $ref: '#/parameters/ids_user_id'
- $ref: '#/parameters/ids_user_login'
- $ref: '#/parameters/ids_current'
- $ref: '#/parameters/ids_category'
- $ref: '#/parameters/ids_place_id'
- $ref: '#/parameters/ids_quality_grade'
- $ref: '#/parameters/ids_taxon_change_id'
- $ref: '#/parameters/ids_taxon_id'
- $ref: '#/parameters/ids_observation_taxon_id'
- $ref: '#/parameters/ids_iconic_taxon_id'
- $ref: '#/parameters/ids_observation_iconic_taxon_id'
- $ref: '#/parameters/ids_lrank'
- $ref: '#/parameters/ids_hrank'
- $ref: '#/parameters/ids_observation_lrank'
- $ref: '#/parameters/ids_observation_hrank'
- $ref: '#/parameters/ids_without_taxon_id'
- $ref: '#/parameters/ids_without_observation_taxon_id'
- $ref: '#/parameters/ids_d1'
- $ref: '#/parameters/ids_d2'
- $ref: '#/parameters/ids_observation_created_d1'
- $ref: '#/parameters/ids_observation_created_d2'
- $ref: '#/parameters/ids_observed_d1'
- $ref: '#/parameters/ids_observed_d2'
- $ref: '#/parameters/id_above'
- $ref: '#/parameters/id_below'
- $ref: '#/parameters/page'
- $ref: '#/parameters/per_page'
- $ref: '#/parameters/order'
- $ref: '#/parameters/ids_order_by'
- $ref: '#/parameters/only_id'
- name: taxon_of
type: string
in: query
description: Source of the taxon for counting
enum:
- identification
- observation
default: identification
- name: order
type: string
in: query
description: Sort order
default: desc
enum:
- desc
- asc
tags:
- Identifications
responses:
'200':
description: 'Returns an object with metadata and an array of taxa
'
schema:
$ref: '#/definitions/SpeciesCountsResponse'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/identifications/identifiers:
get:
summary: Identification Identifiers
description: 'Given zero to many of following parameters, returns creators of
identifications matching the search criteria and the count of
matching identifications, ordered by count descending. A
maximum of 500 results will be returned
'
parameters:
- $ref: '#/parameters/ids_current_taxon'
- $ref: '#/parameters/ids_own_observation'
- $ref: '#/parameters/ids_is_change'
- $ref: '#/parameters/ids_taxon_active'
- $ref: '#/parameters/ids_observation_taxon_active'
- $ref: '#/parameters/ids_id'
- $ref: '#/parameters/ids_rank'
- $ref: '#/parameters/ids_observation_rank'
- $ref: '#/parameters/ids_user_id'
- $ref: '#/parameters/ids_user_login'
- $ref: '#/parameters/ids_current'
- $ref: '#/parameters/ids_category'
- $ref: '#/parameters/ids_place_id'
- $ref: '#/parameters/ids_quality_grade'
- $ref: '#/parameters/ids_taxon_change_id'
- $ref: '#/parameters/ids_taxon_id'
- $ref: '#/parameters/ids_observation_taxon_id'
- $ref: '#/parameters/ids_iconic_taxon_id'
- $ref: '#/parameters/ids_observation_iconic_taxon_id'
- $ref: '#/parameters/ids_lrank'
- $ref: '#/parameters/ids_hrank'
- $ref: '#/parameters/ids_observation_lrank'
- $ref: '#/parameters/ids_observation_hrank'
- $ref: '#/parameters/ids_without_taxon_id'
- $ref: '#/parameters/ids_without_observation_taxon_id'
- $ref: '#/parameters/ids_d1'
- $ref: '#/parameters/ids_d2'
- $ref: '#/parameters/ids_observation_created_d1'
- $ref: '#/parameters/ids_observation_created_d2'
- $ref: '#/parameters/ids_observed_d1'
- $ref: '#/parameters/ids_observed_d2'
- $ref: '#/parameters/id_above'
- $ref: '#/parameters/id_below'
- $ref: '#/parameters/page'
- $ref: '#/parameters/per_page'
- $ref: '#/parameters/order'
- $ref: '#/parameters/ids_order_by'
- $ref: '#/parameters/only_id'
tags:
- Identifications
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'
/identifications/observers:
get:
summary: Identification Observers
description: 'Given zero to many of following parameters, returns creators of
observations of identifications matching the search criteria and
the count of matching observations, ordered by count descending
'
parameters:
- $ref: '#/parameters/ids_current_taxon'
- $ref: '#/parameters/ids_own_observation'
- $ref: '#/parameters/ids_is_change'
- $ref: '#/parameters/ids_taxon_active'
- $ref: '#/parameters/ids_observation_taxon_active'
- $ref: '#/parameters/ids_id'
- $ref: '#/parameters/ids_rank'
- $ref: '#/parameters/ids_observation_rank'
- $ref: '#/parameters/ids_user_id'
- $ref: '#/parameters/ids_user_login'
- $ref: '#/parameters/ids_current'
- $ref: '#/parameters/ids_category'
- $ref: '#/parameters/ids_place_id'
- $ref: '#/parameters/ids_quality_grade'
- $ref: '#/parameters/ids_taxon_change_id'
- $ref: '#/parameters/ids_taxon_id'
- $ref: '#/parameters/ids_observation_taxon_id'
- $ref: '#/parameters/ids_iconic_taxon_id'
- $ref: '#/parameters/ids_observation_iconic_taxon_id'
- $ref: '#/parameters/ids_lrank'
- $ref: '#/parameters/ids_hrank'
- $ref: '#/parameters/ids_observation_lrank'
- $ref: '#/parameters/ids_observation_hrank'
- $ref: '#/parameters/ids_without_taxon_id'
- $ref: '#/parameters/ids_without_observation_taxon_id'
- $ref: '#/parameters/ids_d1'
- $ref: '#/parameters/ids_d2'
- $ref: '#/parameters/ids_observation_created_d1'
- $ref: '#/parameters/ids_observation_created_d2'
- $ref: '#/parameters/ids_observed_d1'
- $ref: '#/parameters/ids_observed_d2'
- $ref: '#/parameters/id_above'
- $ref: '#/parameters/id_below'
- $ref: '#/parameters/page'
- $ref: '#/parameters/per_page'
- $ref: '#/parameters/order'
- $ref: '#/parameters/ids_order_by'
- $ref: '#/parameters/only_id'
tags:
- Identifications
responses:
'200':
description: 'Returns an object with metadata and an array of observers
'
schema:
$ref: '#/definitions/UserCountsResponse'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/identifications/recent_taxa:
get:
summary: Identification Recent Taxa
description: 'Returns an array of objects each containing an identification and a
taxon. Returns IDs representing the earliest occurrence of taxa
associated with identifications in the filtered set of results
'
parameters:
- $ref: '#/parameters/ids_current_taxon'
- $ref: '#/parameters/ids_own_observation'
- $ref: '#/parameters/ids_is_change'
- $ref: '#/parameters/ids_taxon_active'
- $ref: '#/parameters/ids_observation_taxon_active'
- $ref: '#/parameters/ids_id'
- $ref: '#/parameters/ids_rank'
- $ref: '#/parameters/ids_observation_rank'
- $ref: '#/parameters/ids_user_id'
- $ref: '#/parameters/ids_user_login'
- $ref: '#/parameters/ids_current'
- $ref: '#/parameters/ids_category'
- $ref: '#/parameters/ids_place_id'
- $ref: '#/parameters/ids_quality_grade'
- $ref: '#/parameters/ids_taxon_change_id'
- $ref: '#/parameters/ids_taxon_id'
- $ref: '#/parameters/ids_observation_taxon_id'
- $ref: '#/parameters/ids_iconic_taxon_id'
- $ref: '#/parameters/ids_observation_iconic_taxon_id'
- $ref: '#/parameters/ids_lrank'
- $ref: '#/parameters/ids_hrank'
- $ref: '#/parameters/ids_observation_lrank'
- $ref: '#/parameters/ids_observation_hrank'
- $ref: '#/parameters/ids_without_taxon_id'
- $ref: '#/parameters/ids_without_observation_taxon_id'
- $ref: '#/parameters/ids_d1'
- $ref: '#/parameters/ids_d2'
- $ref: '#/parameters/ids_observation_created_d1'
- $ref: '#/parameters/ids_observation_created_d2'
- $ref: '#/parameters/ids_observed_d1'
- $ref: '#/parameters/ids_observed_d2'
- $ref: '#/parameters/id_above'
- $ref: '#/parameters/id_below'
- $ref: '#/parameters/page'
- $ref: '#/parameters/per_page'
- $ref: '#/parameters/order'
- $ref: '#/parameters/ids_order_by'
- $ref: '#/parameters/only_id'
tags:
- Identifications
responses:
'200':
description: OK
/identifications/similar_species:
get:
summary: Identification Similar Species
description: 'Returns species attached to IDs of observations of this taxon, or
attached to observations identified as this species, ordered by combined
frequency descending. This will only return species in the same iconic
taxon, and will never return descendants of the chosen taxon
'
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/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'
- name: taxon_id
type: integer
in: query
minimum: 1
description: Only show observations of these taxa and their descendants
required: true
tags:
- Identifications
responses:
'200':
description: OK
definitions:
User:
type: object
properties:
created_at:
type: string
format: date-time
id:
type: integer
icon:
type: string
icon_url:
type: string
identifications_count:
type: integer
journal_posts_count:
type: integer
login:
type: string
name:
type: string
observations_count:
type: integer
orcid:
type: string
roles:
type: array
items:
type: string
enum:
- admin
- app owner
- curator
site_id:
type: integer
species_count:
type: integer
spam:
type: boolean
suspended:
type: boolean
TaxonConservationStatus:
allOf:
- $ref: '#/definitions/RawConservationStatus'
- type: object
properties:
place:
$ref: '#/definitions/CorePlace'
EstablishmentMeans:
type: object
properties:
establishment_means:
type: string
place:
$ref: '#/definitions/CorePlace'
CorePlace:
type: object
properties:
id:
type: integer
name:
type: string
display_name:
type: string
SpeciesCountsResponse:
allOf:
- $ref: '#/definitions/BaseResponse'
- required:
- results
properties:
results:
type: array
items:
type: object
properties:
count:
type: integer
taxon:
$ref: '#/definitions/ShowTaxon'
ShowTaxon:
allOf:
- $ref: '#/definitions/CoreTaxon'
- type: object
properties:
ancestor_ids:
type: array
items:
type: integer
colors:
type: array
items:
$ref: '#/definitions/Color'
conservation_status:
$ref: '#/definitions/ConservationStatus'
conservation_statuses:
type: array
items:
$ref: '#/definitions/TaxonConservationStatus'
default_photo:
$ref: '#/definitions/TaxonPhoto'
establishment_means:
$ref: '#/definitions/EstablishmentMeans'
observations_count:
type: integer
preferred_establishment_means:
type: string
ConservationStatus:
type: object
properties:
place_id:
type: integer
place:
$ref: '#/definitions/CorePlace'
status:
type: string
PostIdentification:
type: object
properties:
identification:
type: object
properties:
observation_id:
type: integer
taxon_id:
type: integer
current:
type: boolean
body:
type: string
RawConservationStatus:
type: object
properties:
source_id:
type: integer
description: 'Identifier for the iNat source record associated with this status,
retrievable via https://www.inaturalist.org/sources/:id.json
(this endpoint is not a part of our public API and is thus subject to
change or removal)
'
authority:
type: string
description: 'Organization that declared this status
'
status:
type: string
description: 'Body of the status, often coded, particularly when the status comes
from the IUCN or NatureServe. Consult the authority and/or the
status URL for details about the meanings of codes.
'
status_name:
type: string
description: 'Human-readable name of the status if it was coded.
'
iucn:
type: integer
description: 'Coded value representing the equivalent IUCN status. Mappings:
NOT_EVALUATED = 0, DATA_DEFICIENT = 5, LEAST_CONCERN = 10,
NEAR_THREATENED = 20, VULNERABLE = 30, ENDANGERED = 40,
CRITICALLY_ENDANGERED = 50, EXTINCT_IN_THE_WILD = 60, EXTINCT = 70
'
geoprivacy:
type: string
description: 'Default geoprivacy for observations of this taxon in the status''s place.
'
Error:
type: object
properties:
code:
type: integer
message:
type: string
Photo:
type: object
properties:
id:
type: integer
attribution:
type: string
license_code:
type: string
url:
type: string
CoreTaxon:
type: object
properties:
id:
type: integer
iconic_taxon_id:
type: integer
iconic_taxon_name:
type: string
is_active:
type: boolean
name:
type: string
preferred_common_name:
type: string
rank:
type: string
rank_level:
type: number
BaseResponse:
type: object
properties:
total_results:
type: integer
page:
type: integer
per_page:
type: integer
Color:
type: object
properties:
id:
type: integer
value:
type: string
UserCountsResponse:
allOf:
- $ref: '#/definitions/BaseResponse'
- required:
- results
properties:
results:
type: array
items:
type: object
properties:
count:
type: integer
user:
$ref: '#/definitions/User'
TaxonPhoto:
allOf:
- $ref: '#/definitions/Photo'
- type: object
properties:
medium_url:
type: string
square_url:
type: string
parameters:
observed_on:
name: observed_on
type: string
format: date
in: query
description: Must be observed on this date
created_year:
name: created_year
type: array
items:
type: string
in: query
minimum: 1
description: Must be created within this year
ids_taxon_active:
name: taxon_active
type: boolean
in: query
description: ID's taxon is currently an active taxon
viewer_id:
name: viewer_id
type: string
in: query
description: See `reviewed`
created_on:
name: created_on
type: string
format: date
in: query
description: Must be created on this date
ids_without_observation_taxon_id:
name: without_observation_taxon_id
type: array
items:
type: string
in: query
minimum: 1
description: Exclude IDs of observations of these taxa and their descendants
ids_user_id:
name: user_id
type: array
items:
type: integer
in: query
minimum: 1
description: Identifier must have this user ID
ids_order_by:
name: order_by
type: string
in: query
description: Sort field
default: created_at
enum:
- created_at
- id
list_id:
name: list_id
type: integer
in: query
description: Taxon must be in the list with this ID
ids_is_change:
name: is_change
type: boolean
in: query
description: ID was created as a results of a taxon change
page:
name: page
type: string
in: query
description: Pagination `page` number
ids_user_login:
name: user_login
type: array
items:
type: string
in: query
description: Identifier must have this login
unobs
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/inaturalist/refs/heads/main/openapi/inaturalist-identifications-api-openapi.yml