iNaturalist · Example Payload

Get Taxa Autocomplete

BiodiversityNatureCitizen ScienceWildlifeObservationsTaxaEcology

Get Taxa Autocomplete is an example object payload from iNaturalist, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryparametersexampleResponse

Example Payload

Raw ↑ 
{
  "operationId": "get-taxa-autocomplete",
  "method": "GET",
  "path": "/taxa/autocomplete",
  "summary": "Taxon Autocomplete",
  "parameters": [
    {
      "$ref": "#/parameters/autocomplete_q"
    },
    {
      "name": "is_active",
      "type": "boolean",
      "in": "query",
      "description": "Taxon is `active`"
    },
    {
      "$ref": "#/parameters/taxa_taxon_id"
    },
    {
      "$ref": "#/parameters/rank"
    },
    {
      "$ref": "#/parameters/rank_level"
    },
    {
      "name": "per_page",
      "type": "string",
      "in": "query",
      "description": "Number of results to return in a `page`. The maximum value is 30 for this endpoint"
    },
    {
      "$ref": "#/parameters/locale"
    },
    {
      "$ref": "#/parameters/preferred_place_id"
    },
    {
      "$ref": "#/parameters/all_names"
    }
  ],
  "exampleResponse": null
}