inaturalistjs
    Preparing search index...

    Type Alias GetPointsByZoomByXByYGridJsonData

    type GetPointsByZoomByXByYGridJsonData = {
        body?: never;
        path: { x: number; y: number; zoom: number };
        query?: {
            acc?: boolean;
            accAbove?: string;
            accBelow?: string;
            accBelowOrUnknown?: string;
            annotationUserId?: string[];
            applyProjectRulesFor?: string;
            captive?: boolean;
            color?: string;
            createdD1?: string;
            createdD2?: string;
            createdDay?: string[];
            createdMonth?: string[];
            createdOn?: string;
            createdYear?: string[];
            cs?: string;
            csa?: string;
            csi?: "LC" | "NT" | "VU" | "EN" | "CR" | "EW" | "EX";
            d1?: string;
            d2?: string;
            day?: string[];
            endemic?: boolean;
            expectedNearby?: boolean;
            geo?: boolean;
            geoprivacy?: "obscured" | "obscured_private" | "open" | "private";
            hour?: string[];
            hrank?:
                | "kingdom"
                | "phylum"
                | "subphylum"
                | "superclass"
                | "class"
                | "subclass"
                | "superorder"
                | "order"
                | "suborder"
                | "infraorder"
                | "superfamily"
                | "epifamily"
                | "family"
                | "subfamily"
                | "supertribe"
                | "tribe"
                | "subtribe"
                | "genus"
                | "genushybrid"
                | "species"
                | "hybrid"
                | "subspecies"
                | "variety"
                | "form";
            iconicTaxa?: | "Actinopterygii"
            | "Animalia"
            | "Amphibia"
            | "Arachnida"
            | "Aves"
            | "Chromista"
            | "Fungi"
            | "Insecta"
            | "Mammalia"
            | "Mollusca"
            | "Reptilia"
            | "Plantae"
            | "Protozoa"
            | "unknown";
            id?: string[];
            idAbove?: string;
            idBelow?: string;
            identifications?: "most_agree"
            | "most_disagree"
            | "some_agree";
            identified?: boolean;
            identUserId?: number;
            idPlease?: boolean;
            introduced?: boolean;
            lat?: number;
            license?:
                | "cc-by"
                | "cc-by-nc"
                | "cc-by-nd"
                | "cc-by-sa"
                | "cc-by-nc-nd"
                | "cc-by-nc-sa"
                | "cc0";
            licensed?: boolean;
            listId?: number;
            lng?: number;
            lrank?: | "kingdom"
            | "phylum"
            | "subphylum"
            | "superclass"
            | "class"
            | "subclass"
            | "superorder"
            | "order"
            | "suborder"
            | "infraorder"
            | "superfamily"
            | "epifamily"
            | "family"
            | "subfamily"
            | "supertribe"
            | "tribe"
            | "subtribe"
            | "genus"
            | "genushybrid"
            | "species"
            | "hybrid"
            | "subspecies"
            | "variety"
            | "form";
            mappable?: boolean;
            month?: string[];
            native?: boolean;
            nelat?: number;
            nelng?: number;
            notId?: string[];
            notInProject?: string;
            notMatchingProjectRulesFor?: string;
            obscuration?: "obscured"
            | "private"
            | "none";
            observationAccuracyExperimentId?: number[];
            observedOn?: string;
            ofvDatatype?: string[];
            outOfRange?: boolean;
            pcid?: boolean;
            photoLicense?:
                | "cc-by"
                | "cc-by-nc"
                | "cc-by-nd"
                | "cc-by-sa"
                | "cc-by-nc-nd"
                | "cc-by-nc-sa"
                | "cc0";
            photoLicensed?: boolean;
            photos?: boolean;
            placeId?: number[];
            popular?: boolean;
            projectId?: string[];
            q?: string;
            qualityGrade?: "casual"
            | "needs_id"
            | "research";
            radius?: string;
            rank?:
                | "kingdom"
                | "phylum"
                | "subphylum"
                | "superclass"
                | "class"
                | "subclass"
                | "superorder"
                | "order"
                | "suborder"
                | "infraorder"
                | "superfamily"
                | "epifamily"
                | "family"
                | "subfamily"
                | "supertribe"
                | "tribe"
                | "subtribe"
                | "genus"
                | "genushybrid"
                | "species"
                | "hybrid"
                | "subspecies"
                | "variety"
                | "form";
            reviewed?: boolean;
            searchOn?: "names"
            | "tags"
            | "description"
            | "place";
            siteId?: string[];
            soundLicense?:
                | "cc-by"
                | "cc-by-nc"
                | "cc-by-nd"
                | "cc-by-sa"
                | "cc-by-nc-nd"
                | "cc-by-nc-sa"
                | "cc0";
            sounds?: boolean;
            swlat?: number;
            swlng?: number;
            taxonGeoprivacy?: "obscured"
            | "obscured_private"
            | "open"
            | "private";
            taxonId?: string[];
            taxonIsActive?: boolean;
            taxonName?: string[];
            termId?: number[];
            termIdOrUnknown?: number[];
            termValueId?: number[];
            threatened?: boolean;
            unobservedByUserId?: number;
            updatedSince?: string;
            userId?: string[];
            userLogin?: string[];
            verifiable?: boolean;
            viewerId?: string;
            withoutTaxonId?: string[];
            withoutTermId?: number;
            withoutTermValueId?: number[];
            year?: string[];
        };
        url: "/points/{zoom}/{x}/{y}.grid.json";
    }
    Index

    Properties

    Properties

    body?: never
    path: { x: number; y: number; zoom: number }

    Type declaration

    • x: number

      X coordinate in the XYZ tiling scheme. Must be less than 2^zoom

    • y: number

      Y coordinate in the XYZ tiling scheme. Must be less than 2^zoom

    • zoom: number

      Zoom level. Z coordinate in the XYZ tiling scheme

    query?: {
        acc?: boolean;
        accAbove?: string;
        accBelow?: string;
        accBelowOrUnknown?: string;
        annotationUserId?: string[];
        applyProjectRulesFor?: string;
        captive?: boolean;
        color?: string;
        createdD1?: string;
        createdD2?: string;
        createdDay?: string[];
        createdMonth?: string[];
        createdOn?: string;
        createdYear?: string[];
        cs?: string;
        csa?: string;
        csi?: "LC" | "NT" | "VU" | "EN" | "CR" | "EW" | "EX";
        d1?: string;
        d2?: string;
        day?: string[];
        endemic?: boolean;
        expectedNearby?: boolean;
        geo?: boolean;
        geoprivacy?: "obscured" | "obscured_private" | "open" | "private";
        hour?: string[];
        hrank?:
            | "kingdom"
            | "phylum"
            | "subphylum"
            | "superclass"
            | "class"
            | "subclass"
            | "superorder"
            | "order"
            | "suborder"
            | "infraorder"
            | "superfamily"
            | "epifamily"
            | "family"
            | "subfamily"
            | "supertribe"
            | "tribe"
            | "subtribe"
            | "genus"
            | "genushybrid"
            | "species"
            | "hybrid"
            | "subspecies"
            | "variety"
            | "form";
        iconicTaxa?: | "Actinopterygii"
        | "Animalia"
        | "Amphibia"
        | "Arachnida"
        | "Aves"
        | "Chromista"
        | "Fungi"
        | "Insecta"
        | "Mammalia"
        | "Mollusca"
        | "Reptilia"
        | "Plantae"
        | "Protozoa"
        | "unknown";
        id?: string[];
        idAbove?: string;
        idBelow?: string;
        identifications?: "most_agree"
        | "most_disagree"
        | "some_agree";
        identified?: boolean;
        identUserId?: number;
        idPlease?: boolean;
        introduced?: boolean;
        lat?: number;
        license?:
            | "cc-by"
            | "cc-by-nc"
            | "cc-by-nd"
            | "cc-by-sa"
            | "cc-by-nc-nd"
            | "cc-by-nc-sa"
            | "cc0";
        licensed?: boolean;
        listId?: number;
        lng?: number;
        lrank?: | "kingdom"
        | "phylum"
        | "subphylum"
        | "superclass"
        | "class"
        | "subclass"
        | "superorder"
        | "order"
        | "suborder"
        | "infraorder"
        | "superfamily"
        | "epifamily"
        | "family"
        | "subfamily"
        | "supertribe"
        | "tribe"
        | "subtribe"
        | "genus"
        | "genushybrid"
        | "species"
        | "hybrid"
        | "subspecies"
        | "variety"
        | "form";
        mappable?: boolean;
        month?: string[];
        native?: boolean;
        nelat?: number;
        nelng?: number;
        notId?: string[];
        notInProject?: string;
        notMatchingProjectRulesFor?: string;
        obscuration?: "obscured"
        | "private"
        | "none";
        observationAccuracyExperimentId?: number[];
        observedOn?: string;
        ofvDatatype?: string[];
        outOfRange?: boolean;
        pcid?: boolean;
        photoLicense?:
            | "cc-by"
            | "cc-by-nc"
            | "cc-by-nd"
            | "cc-by-sa"
            | "cc-by-nc-nd"
            | "cc-by-nc-sa"
            | "cc0";
        photoLicensed?: boolean;
        photos?: boolean;
        placeId?: number[];
        popular?: boolean;
        projectId?: string[];
        q?: string;
        qualityGrade?: "casual"
        | "needs_id"
        | "research";
        radius?: string;
        rank?:
            | "kingdom"
            | "phylum"
            | "subphylum"
            | "superclass"
            | "class"
            | "subclass"
            | "superorder"
            | "order"
            | "suborder"
            | "infraorder"
            | "superfamily"
            | "epifamily"
            | "family"
            | "subfamily"
            | "supertribe"
            | "tribe"
            | "subtribe"
            | "genus"
            | "genushybrid"
            | "species"
            | "hybrid"
            | "subspecies"
            | "variety"
            | "form";
        reviewed?: boolean;
        searchOn?: "names"
        | "tags"
        | "description"
        | "place";
        siteId?: string[];
        soundLicense?:
            | "cc-by"
            | "cc-by-nc"
            | "cc-by-nd"
            | "cc-by-sa"
            | "cc-by-nc-nd"
            | "cc-by-nc-sa"
            | "cc0";
        sounds?: boolean;
        swlat?: number;
        swlng?: number;
        taxonGeoprivacy?: "obscured"
        | "obscured_private"
        | "open"
        | "private";
        taxonId?: string[];
        taxonIsActive?: boolean;
        taxonName?: string[];
        termId?: number[];
        termIdOrUnknown?: number[];
        termValueId?: number[];
        threatened?: boolean;
        unobservedByUserId?: number;
        updatedSince?: string;
        userId?: string[];
        userLogin?: string[];
        verifiable?: boolean;
        viewerId?: string;
        withoutTaxonId?: string[];
        withoutTermId?: number;
        withoutTermValueId?: number[];
        year?: string[];
    }

    Type declaration

    • Optionalacc?: boolean

      Whether or not positional accuracy / coordinate uncertainty has been specified

    • OptionalaccAbove?: string

      Must have a positional accuracy above this value (meters)

    • OptionalaccBelow?: string

      Must have a positional accuracy below this value (meters)

    • OptionalaccBelowOrUnknown?: string

      Positional accuracy must be below this value (in meters) or be unknown

    • OptionalannotationUserId?: string[]

      Must have an annotation created by this user

    • OptionalapplyProjectRulesFor?: string

      Must match the rules of the project with this ID or slug

    • Optionalcaptive?: boolean

      Captive or cultivated observations

    • Optionalcolor?: string

      Primary color to use in tile creation. Accepts common colors by string (e.g. color=blue), and accepts escaped color HEX codes (e.g. color=%2386a91c)

    • OptionalcreatedD1?: string

      Must be created at or after this time

    • OptionalcreatedD2?: string

      Must be created at or before this time

    • OptionalcreatedDay?: string[]

      Must be created within this day of the month

    • OptionalcreatedMonth?: string[]

      Must be created within this month

    • OptionalcreatedOn?: string

      Must be created on this date

    • OptionalcreatedYear?: string[]

      Must be created within this year

    • Optionalcs?: string

      Taxon must have this conservation status code. If the place_id parameter is also specified, this will only consider statuses specific to that place

    • Optionalcsa?: string

      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

    • Optionalcsi?: "LC" | "NT" | "VU" | "EN" | "CR" | "EW" | "EX"

      Taxon must have this IUCN conservation status. If the place_id parameter is also specified, this will only consider statuses specific to that place

    • Optionald1?: string

      Must be observed on or after this date

    • Optionald2?: string

      Must be observed on or before this date

    • Optionalday?: string[]

      Must be observed within this day of the month

    • Optionalendemic?: boolean

      Observations whose taxa are endemic to their location

    • OptionalexpectedNearby?: boolean

      Observation taxon is expected nearby

    • Optionalgeo?: boolean

      Observations that are georeferenced

    • Optionalgeoprivacy?: "obscured" | "obscured_private" | "open" | "private"

      Must have this geoprivacy setting

    • Optionalhour?: string[]

      Must be observed within this hour of the day

    • Optionalhrank?:
          | "kingdom"
          | "phylum"
          | "subphylum"
          | "superclass"
          | "class"
          | "subclass"
          | "superorder"
          | "order"
          | "suborder"
          | "infraorder"
          | "superfamily"
          | "epifamily"
          | "family"
          | "subfamily"
          | "supertribe"
          | "tribe"
          | "subtribe"
          | "genus"
          | "genushybrid"
          | "species"
          | "hybrid"
          | "subspecies"
          | "variety"
          | "form"

      Taxon must have this rank or lower

    • OptionaliconicTaxa?:
          | "Actinopterygii"
          | "Animalia"
          | "Amphibia"
          | "Arachnida"
          | "Aves"
          | "Chromista"
          | "Fungi"
          | "Insecta"
          | "Mammalia"
          | "Mollusca"
          | "Reptilia"
          | "Plantae"
          | "Protozoa"
          | "unknown"

      Taxon must by within this iconic taxon

    • Optionalid?: string[]

      Must have this ID

    • OptionalidAbove?: string

      Must have an ID above this value

    • OptionalidBelow?: string

      Must have an ID below this value

    • Optionalidentifications?: "most_agree" | "most_disagree" | "some_agree"

      Identifications must meet these criteria

    • Optionalidentified?: boolean

      Observations that have community identifications

    • OptionalidentUserId?: number

      Observations identified by a particular user

    • OptionalidPlease?: boolean

      Observations with the deprecated ID, Please! flag. Note that this will return observations, but that this attribute is no longer used.

    • Optionalintroduced?: boolean

      Observations whose taxa are introduced in their location

    • Optionallat?: number

      Must be within a {radius} kilometer circle around this lat/lng (*lat, *lng, radius)

    • Optionallicense?:
          | "cc-by"
          | "cc-by-nc"
          | "cc-by-nd"
          | "cc-by-sa"
          | "cc-by-nc-nd"
          | "cc-by-nc-sa"
          | "cc0"

      Observation must have this license

    • Optionallicensed?: boolean

      License attribute of an observation must not be null

    • OptionallistId?: number

      Taxon must be in the list with this ID

    • Optionallng?: number

      Must be within a {radius} kilometer circle around this lat/lng (*lat, *lng, radius)

    • Optionallrank?:
          | "kingdom"
          | "phylum"
          | "subphylum"
          | "superclass"
          | "class"
          | "subclass"
          | "superorder"
          | "order"
          | "suborder"
          | "infraorder"
          | "superfamily"
          | "epifamily"
          | "family"
          | "subfamily"
          | "supertribe"
          | "tribe"
          | "subtribe"
          | "genus"
          | "genushybrid"
          | "species"
          | "hybrid"
          | "subspecies"
          | "variety"
          | "form"

      Taxon must have this rank or higher

    • Optionalmappable?: boolean

      Observations that show on map tiles

    • Optionalmonth?: string[]

      Must be observed within this month

    • Optionalnative?: boolean

      Observations whose taxa are native to their location

    • Optionalnelat?: number

      Must be within this bounding box (*nelat, *nelng, *swlat, *swlng)

    • Optionalnelng?: number

      Must be within this bounding box (*nelat, *nelng, *swlat, *swlng)

    • OptionalnotId?: string[]

      Must not have this ID

    • OptionalnotInProject?: string

      Must not be in the project with this ID or slug

    • OptionalnotMatchingProjectRulesFor?: string

      Must not match the rules of the project with this ID or slug

    • Optionalobscuration?: "obscured" | "private" | "none"

      Must have geoprivacy or taxon_geoprivacy fields matching these values

    • OptionalobservationAccuracyExperimentId?: number[]

      Must included in this observation accuracy experiment

    • OptionalobservedOn?: string

      Must be observed on this date

    • OptionalofvDatatype?: string[]

      Must have an observation field value with this datatype

    • OptionaloutOfRange?: boolean

      Observations whose taxa are outside their known ranges

    • Optionalpcid?: boolean

      Observations identified by the curator of a project. If the project_id parameter is also specified, this will only consider observations identified by curators of the specified project(s)

    • OptionalphotoLicense?:
          | "cc-by"
          | "cc-by-nc"
          | "cc-by-nd"
          | "cc-by-sa"
          | "cc-by-nc-nd"
          | "cc-by-nc-sa"
          | "cc0"

      Must have at least one photo with this license

    • OptionalphotoLicensed?: boolean

      License attribute of at least one photo of an observation must not be null

    • Optionalphotos?: boolean

      Observations with photos

    • OptionalplaceId?: number[]

      Must be observed within the place with this ID

    • Optionalpopular?: boolean

      Observations that have been favorited by at least one user

    • OptionalprojectId?: string[]

      Must be added to the project this ID or slug

    • Optionalq?: string

      Search observation properties. Can be combined with search_on

    • OptionalqualityGrade?: "casual" | "needs_id" | "research"

      Must have this quality grade

    • Optionalradius?: string

      Must be within a {radius} kilometer circle around this lat/lng (*lat, *lng, radius)

    • Optionalrank?:
          | "kingdom"
          | "phylum"
          | "subphylum"
          | "superclass"
          | "class"
          | "subclass"
          | "superorder"
          | "order"
          | "suborder"
          | "infraorder"
          | "superfamily"
          | "epifamily"
          | "family"
          | "subfamily"
          | "supertribe"
          | "tribe"
          | "subtribe"
          | "genus"
          | "genushybrid"
          | "species"
          | "hybrid"
          | "subspecies"
          | "variety"
          | "form"

      Taxon must have this rank

    • Optionalreviewed?: boolean

      Observations have been reviewed by the user with ID equal to the value of the viewer_id parameter

    • OptionalsearchOn?: "names" | "tags" | "description" | "place"

      Properties to search on, when combined with q. Searches across all properties by default

    • OptionalsiteId?: string[]

      Must be affiliated with the iNaturalist network website with this ID

    • OptionalsoundLicense?:
          | "cc-by"
          | "cc-by-nc"
          | "cc-by-nd"
          | "cc-by-sa"
          | "cc-by-nc-nd"
          | "cc-by-nc-sa"
          | "cc0"

      Must have at least one sound with this license

    • Optionalsounds?: boolean

      Observations with sounds

    • Optionalswlat?: number

      Must be within this bounding box (*nelat, *nelng, *swlat, *swlng)

    • Optionalswlng?: number

      Must be within this bounding box (*nelat, *nelng, *swlat, *swlng)

    • OptionaltaxonGeoprivacy?: "obscured" | "obscured_private" | "open" | "private"

      Filter observations by the most conservative geoprivacy applied by a conservation status associated with one of the taxa proposed in the current identifications.

    • OptionaltaxonId?: string[]

      Only show observations of these taxa and their descendants

    • OptionaltaxonIsActive?: boolean

      Observations of active taxon concepts

    • OptionaltaxonName?: string[]

      Taxon must have a scientific or common name matching this string

    • OptionaltermId?: number[]

      Must have an annotation using this controlled term ID

    • OptionaltermIdOrUnknown?: number[]

      Must be combined with the term_value_id or the without_term_value_id parameter. Must have an annotation using this controlled term ID and associated term value IDs or be missing this annotation.

    • OptionaltermValueId?: number[]

      Must have an annotation using this controlled value ID. Must be combined with the term_id parameter

    • Optionalthreatened?: boolean

      Observations whose taxa are threatened in their location

    • OptionalunobservedByUserId?: number

      Must not be of a taxon previously observed by this user

    • OptionalupdatedSince?: string

      Must be updated since this time

    • OptionaluserId?: string[]

      User must have this ID or login

    • OptionaluserLogin?: string[]

      User must have this login

    • Optionalverifiable?: boolean

      Observations with a quality_grade of either needs_id or research. Equivalent to quality_grade=needs_id,research

    • OptionalviewerId?: string

      See reviewed

    • OptionalwithoutTaxonId?: string[]

      Exclude observations of these taxa and their descendants

    • OptionalwithoutTermId?: number

      Exclude observations with annotations using this controlled value ID.

    • OptionalwithoutTermValueId?: number[]

      Exclude observations with annotations using this controlled value ID. Must be combined with the term_id parameter

    • Optionalyear?: string[]

      Must be observed within this year

    url: "/points/{zoom}/{x}/{y}.grid.json"