inaturalistjs
    Preparing search index...

    Type Alias GetSearchData

    type GetSearchData = {
        body?: never;
        path?: never;
        query?: {
            includeTaxonAncestors?: boolean;
            locale?: string;
            perPage?: string;
            placeId?: string[];
            preferredPlaceId?: number;
            q?: string;
            sources?: "places" | "projects" | "taxa" | "users";
        };
        url: "/search";
    }
    Index

    Properties

    body? path? query? url

    Properties

    Optionalbody

    body?: never
    path?: never
    query?: {
        includeTaxonAncestors?: boolean;
        locale?: string;
        perPage?: string;
        placeId?: string[];
        preferredPlaceId?: number;
        q?: string;
        sources?: "places" | "projects" | "taxa" | "users";
    }

    Type declaration

    • OptionalincludeTaxonAncestors?: boolean

      Include taxon ancestors in the response

    • Optionallocale?: string

      Locale preference for taxon common names

    • OptionalperPage?: string

      Number of results to return in a page. The maximum value is generally 200 unless otherwise noted

    • OptionalplaceId?: string[]

      Must be associated with this place

    • OptionalpreferredPlaceId?: number

      Place preference for regional taxon common names

    • Optionalq?: string

      Search object properties

    • Optionalsources?: "places" | "projects" | "taxa" | "users"

      Must be of this type

    url: "/search"

    Settings

    Member Visibility

    On This Page

    Properties