Endpoint Summary#

Below is a list of iNaturalist API endpoints that have either been added or are likely be added in the future, along with their corresponding functions in pyinaturalist.

v1 API#

For all available endpoints, see: http://api.inaturalist.org/v1/docs/

Method

Endpoint

Function

POST

/annotations

DELETE

/annotations/{id}

POST

/comments

DELETE

/comments/{id}

PUT

/comments/{id}

GET

/controlled_terms

get_controlled_terms()

GET

/controlled_terms/for_taxon

get_controlled_terms()

GET

/identifications

get_identifications()

GET

/identifications/{id}

get_identifications_by_id()

GET

/identifications/species_counts

GET

/identifications/identifiers

GET

/identifications/observers

GET

/identifications/similar_species

GET

/messages

get_messages()

GET

/messages/{id}

get_message_by_id()

GET

/messages/unread

get_unread_message_count()

DELETE

/observation_field_values/{id}

delete_observation_field()

PUT

/observation_field_values/{id}

set_observation_field()

POST

/observation_field_values

set_observation_field()

POST

/observation_photos

upload()

POST

/observation_sounds

upload()

DELETE

/observations/{id}

delete_observation()

GET

/observations/{id}

get_observations_by_id()

PUT

/observations/{id}

update_observation()

GET

/observations/{id}/taxon_summary

get_observation_taxon_summary()

GET

/observations

get_observations()

POST

/observations

create_observation()

GET

/observations/histogram

get_observation_histogram()

GET

/observations/identifiers

get_observation_identifiers()

GET

/observations/observers

get_observation_observers()

GET

/observations/popular_field_values

get_observation_popular_field_values()

GET

/observations/species_counts

get_observation_species_counts()

GET

/observations/taxonomy

get_observation_taxonomy()

GET

/places/{id}

get_places_by_id()

GET

/places/autocomplete

get_places_autocomplete()

GET

/places/nearby

get_places_nearby()

GET

/posts

get_posts()

GET

/projects

get_projects()

GET

/projects/{id}

get_projects_by_id()

PUT

/projects/{id}

update_project()

GET

/projects/{id}/members

GET

/projects/{id}/subscriptions

POST

/projects/{id}/add

add_project_observation()

DELETE

/projects/{id}/remove

delete_project_observation()

GET

/projects/autocomplete

GET

/search

search()

GET

/taxa

get_taxa()

GET

/taxa/{id}

get_taxa_by_id()

GET

/taxa/{id}/map_layers

get_taxa_map_layers()

GET

/taxa/autocomplete

get_taxa_autocomplete()

GET

/taxa/lifelist_metadata

get_life_list_metadata()

GET

/users/{id}

get_user_by_id()

GET

/users/{id}/projects

GET

/users/autocomplete

get_users_autocomplete()

GET

/users/me

get_current_user()

v0 API#

For all available endpoints, see: https://www.inaturalist.org/pages/api+reference

Method

Endpoint

Function

GET

/observations

get_observations()

POST

/observations

create_observation()

PUT

/observations/{id}

update_observation()

DELETE

/observations/{id}

delete_observation()

GET

/observation_fields

get_observation_fields()

PUT

/observation_field_values/{id}

put_observation_field_values()

POST

/observation_photos

upload_photos()

POST

/observation_sounds

upload_sounds()