iNaturalist

iNaturalist UTFGrid API

JSON for observation tiles

GitHub OpenAPI

Documentation

📖
Documentation
https://www.inaturalist.org/pages/api+reference
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/inaturalist/main/rate-limits/rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/inaturalist/refs/heads/main/openapi/inaturalist-utfgrid-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://www.postman.com/collections/inaturalist-api
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/inaturalist/main/plans/plans.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/inaturalist/main/finops/finops.yml

OpenAPI Specification

inaturalist-utfgrid-api-openapi.yml Raw ↑ 
swagger: '2.0'
info:
  title: iNaturalist Annotations UTFGrid 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: UTFGrid
  description: JSON for observation tiles
paths:
  /colored_heatmap/{zoom}/{x}/{y}.grid.json:
    get:
      summary: Colored Heatmap Tiles UTFGrid
      description: 'Given zero to many of following parameters, returns a JSON file

        following the UTFGrid spec, representing observations matching

        the search criteria

        '
      parameters:
      - $ref: '#/parameters/zoom'
      - $ref: '#/parameters/x'
      - $ref: '#/parameters/y'
      - $ref: '#/parameters/tile_color'
      - $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'
      tags:
      - UTFGrid
      responses:
        '200':
          description: 'Returns a UTFGrid

            '
          schema:
            $ref: '#/definitions/UTFGridResponse'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /grid/{zoom}/{x}/{y}.grid.json:
    get:
      summary: Grid Tiles UTFGrid
      description: 'Given zero to many of following parameters, returns a JSON file

        following the UTFGrid spec, representing observations matching

        the search criteria

        '
      parameters:
      - $ref: '#/parameters/zoom'
      - $ref: '#/parameters/x'
      - $ref: '#/parameters/y'
      - $ref: '#/parameters/tile_color'
      - $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'
      tags:
      - UTFGrid
      responses:
        '200':
          description: 'Returns a UTFGrid

            '
          schema:
            $ref: '#/definitions/UTFGridResponse'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /heatmap/{zoom}/{x}/{y}.grid.json:
    get:
      summary: Heatmap Tiles UTFGrid
      description: 'Given zero to many of following parameters, returns a JSON file

        following the UTFGrid spec, representing observations matching

        the search criteria

        '
      parameters:
      - $ref: '#/parameters/zoom'
      - $ref: '#/parameters/x'
      - $ref: '#/parameters/y'
      - $ref: '#/parameters/tile_color'
      - $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'
      tags:
      - UTFGrid
      responses:
        '200':
          description: 'Returns a UTFGrid

            '
          schema:
            $ref: '#/definitions/UTFGridResponse'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
  /points/{zoom}/{x}/{y}.grid.json:
    get:
      summary: Points Tiles UTFGrid
      description: 'Given zero to many of following parameters, returns a JSON file

        following the UTFGrid spec, representing observations matching

        the search criteria

        '
      parameters:
      - $ref: '#/parameters/zoom'
      - $ref: '#/parameters/x'
      - $ref: '#/parameters/y'
      - $ref: '#/parameters/tile_color'
      - $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'
      tags:
      - UTFGrid
      responses:
        '200':
          description: 'Returns a UTFGrid

            '
          schema:
            $ref: '#/definitions/UTFGridResponse'
        default:
          description: Unexpected error
          schema:
            $ref: '#/definitions/Error'
definitions:
  Error:
    type: object
    properties:
      code:
        type: integer
      message:
        type: string
  UTFGridResponse:
    properties:
      grid:
        type: array
        items:
          type: string
      keys:
        type: array
        items:
          type: string
      data:
        type: object
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
  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
  list_id:
    name: list_id
    type: integer
    in: query
    description: Taxon must be in the list with this ID
  unobserved_by_user_id:
    name: unobserved_by_user_id
    type: integer
    in: query
    description: Must not be of a taxon previously observed by this user
  lat:
    name: lat
    type: number
    format: double
    in: query
    description: 'Must be within a {`radius`} kilometer circle around this lat/lng

      (*lat, *lng, radius)

      '
  csa:
    name: csa
    type: string
    in: query
    description: 'Taxon must have a conservation status from this authority. If

      the `place_id` parameter is also specified, this will only consider

      statuses specific to that place

      '
  user_id:
    name: user_id
    type: array
    items:
      type: string
    in: query
    minimum: 1
    description: User must have this ID or login
  sound_license:
    name: sound_license
    type: array
    items:
      type: string
    in: query
    description: Must have at least one sound with this license
    enum:
    - cc-by
    - cc-by-nc
    - cc-by-nd
    - cc-by-sa
    - cc-by-nc-nd
    - cc-by-nc-sa
    - cc0
  out_of_range:
    name: out_of_range
    type: boolean
    in: query
    description: Observations whose taxa are outside their known ranges
  identifications:
    name: identifications
    type: string
    in: query
    description: Identifications must meet these criteria
    enum:
    - most_agree
    - most_disagree
    - some_agree
  photos:
    name: photos
    type: boolean
    in: query
    description: Observations with photos
  taxon_id:
    name: taxon_id
    type: array
    items:
      type: string
    in: query
    minimum: 1
    description: Only show observations of these taxa and their descendants
  lng:
    name: lng
    type: number
    format: double
    in: query
    description: 'Must be within a {`radius`} kilometer circle around this lat/lng

      (*lat, *lng, radius)

      '
  quality_grade:
    name: quality_grade
    type: string
    in: query
    description: Must have this quality grade
    enum:
    - casual
    - needs_id
    - research
  term_value_id:
    name: term_value_id
    type: array
    items:
      type: integer
    in: query
    description: 'Must have an annotation using this controlled value ID. Must be combined

      with the `term_id` parameter

      '
  mappable:
    name: mappable
    type: boolean
    in: query
    description: Observations that show on map tiles
  native:
    name: native
    type: boolean
    in: query
    description: Observations whose taxa are native to their location
  ident_user_id:
    name: ident_user_id
    type: integer
    in: query
    description: Observations identified by a particular user
  taxon_name:
    name: taxon_name
    type: array
    items:
      type: string
    in: query
    description: 'Taxon must have a scientific or common name matching this string

      '
  year:
    name: year
    type: array
    items:
      type: string
    in: query
    minimum: 1
    description: Must be observed within this year
  endemic:
    name: endemic
    type: boolean
    in: query
    description: Observations whose taxa are endemic to their location
  acc_above:
    name: acc_above
    type: string
    in: query
    description: Must have a positional accuracy above this value (meters)
  nelng:
    name: nelng
    type: number
    format: double
    in: query
    description: 'Must be within this bounding box (*nelat, *nelng, *swlat, *swlng)

      '
  fails_dqa_recent:
    name: fails_dqa_recent
    type: boolean
    in: query
    description: Must be voted as not recent evidence of an organism
  without_term_value_id:
    name: without_term_value_id
    type: array
    items:
      type: integer
    in: query
    description: 'Exclude observations with annotations using this controlled value ID.

      Must be combined with the `term_id` parameter

      '
  created_day:
    name: created_day
    type: array
    items:
      type: string
    in: query
    minimum: 1
    maximum: 31
    description: Must be created within this day of the month
  site_id:
    name: site_id
    type: array
    items:
      type: string
    in: query
    description: 'Must be affiliated with the iNaturalist network website with this ID

      '
  expected_nearby:
    name: expected_nearby
    type: boolean
    in: query
    description: Observation taxon is expected nearby
  fails_dqa_needs_id:
    name: fails_dqa_needs_id
    type: boolean
    in: query
    description: Must be voted as the community ID cannot be improved
  d2:
    name: d2
    type: string
    format: date
    in: query
    description: Must be observed on or before this date
  y:
    name: y
    type: integer
    in: path
    required: true
    minimum: 0
    description: Y coordinate in the XYZ tiling scheme. Must be less than 2^zoom
  fails_dqa_wild:
    name: fails_dqa_wild
    type: boolean
    in: query
    description: Must be voted as not wild
  place_id:
    name: place_id
    type: array
    items:
      type: integer
    in: query
    description: Must be observed within the place with this ID
  project_id:
    name: project_id
    type: array
    items:
      type: string
    in: query
    description: Must be added to the project this ID or slug
  radius:
    name: radius
    type: string
    in: query
    description: 'Must be within a {`radius`} kilometer circle around this lat/lng

      (*lat, *lng, radius)

      '
  zoom:
    name: zoom
    type: integer
    in: path
    required: true
    minimum: 0
    maximum: 21
    description: Zoom level. Z coordinate in the XYZ tiling scheme
  annotation_user_id:
    name: annotation_user_id
    type: array
    items:
      type: string
    in: query
    description: 'Must have an annotation created by this user

      '
  fails_dqa_date:
    name: fails_dqa_date
    type: boolean
    in: query
    description: Must be voted as not having an accurate date
  geoprivacy:
    name: geoprivacy
    type: array
    items:
      type: string
    in: query
    description: Must have this geoprivacy setting
    enum:
    - obscured
    - obscured_private
    - open
    - private
  iconic_taxa:
    name: iconic_taxa
    type: array
    items:
      type: string
    in: query
    description: Taxon must by within this iconic taxon
    enum:
    - Actinopterygii
    - Animalia
    - Amphibia
    - Arachnida
    - Aves
    - Chromista
    - Fungi
    - Insecta
    - Mammalia
    - Mollusca
    - Reptilia
    - Plantae
    - Protozoa
    - unknown
  id_below:
    name: id_below
    type: string
    in: query
    description: Must have an ID below this value
  id_please:
    name: id_please
    type: boolean
    in: query
    description: Observations with the deprecated `ID, Please!` flag. Note that this will return observations, but that this attribute is no longer used.
  user_login:
    name: user_login
    type: array
    items:
      type: string
    in: query
    description: User must have this login
  updated_since:
    name: updated_since
    type: string
    in: query
    description: Must be updated since this time
  fails_dqa_accurate:
    name: fails_dqa_accurate
    type: boolean
    in: query
    description: Must be voted as not accurately depicting an organism or scene
  reviewed:
    name: reviewed
    type: boolean
    in: query
    description: 'Observations have been reviewed by the user with ID equal to

      the value of the `viewer_id` parameter

      '
  sounds:
    name: sounds
    type: boolean
    in: query
    description: Observations with sounds
  not_matching_project_rules_for:
    name: not_matching_project_rules_for
    type: string
    in: query
    description: Must not match the rules of the project with this ID or slug
  photo_licensed:
    name: photo_licensed
    type: boolean
    in: query
    description: License attribute of at least one photo of an observation must not be null
  not_in_project:
    name: not_in_project
    type: string
    in: query
    description: Must not be in the project with this ID or slug
  lrank:
    name: lrank
    type: string
    in: query
    description: Taxon must have this rank or higher
    enum:
    - stateofmatter
    - kingdom
    - phylum
    - subphylum
    - superclass
    - class
    - subclass
    - superorder
    - order
    - suborder
    - infraorder
    - superfamily
    - epifamily
    - family
    - subfamily
    - supertribe
    - tribe
    - subtribe
    - genus
    - genushybrid
    - species
    - hybrid
    - subspecies
    - variety
    - form
  geo:
    name: geo
    type: boolean
    in: query
    description: Observations that are georeferenced
  threatened:
    name: threatened
    type: boolean
    in: query
    description: 'Ob

# --- truncated at 32 KB (41 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/inaturalist/refs/heads/main/openapi/inaturalist-utfgrid-api-openapi.yml