inaturalistjs
    Preparing search index...

    Type Alias GetTaxaData

    type GetTaxaData = {
        body?: never;
        path?: never;
        query?: {
            allNames?: boolean;
            idAbove?: string;
            idBelow?: string;
            isActive?: boolean;
            locale?: string;
            onlyId?: boolean;
            order?: "desc" | "asc";
            orderBy?: "id" | "created_at" | "observations_count";
            parentId?: number;
            perPage?: string;
            preferredPlaceId?: number;
            q?: 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";
            rankLevel?: number;
            taxonId?: string[];
        };
        url: "/taxa";
    }
    Index

    Properties

    body? path? query? url

    Properties

    Optionalbody

    body?: never
    path?: never
    query?: {
        allNames?: boolean;
        idAbove?: string;
        idBelow?: string;
        isActive?: boolean;
        locale?: string;
        onlyId?: boolean;
        order?: "desc" | "asc";
        orderBy?: "id" | "created_at" | "observations_count";
        parentId?: number;
        perPage?: string;
        preferredPlaceId?: number;
        q?: 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";
        rankLevel?: number;
        taxonId?: string[];
    }

    Type declaration

    • OptionalallNames?: boolean

      Include all taxon names in the response

    • OptionalidAbove?: string

      Must have an ID above this value

    • OptionalidBelow?: string

      Must have an ID below this value

    • OptionalisActive?: boolean

      Taxon is active

    • Optionallocale?: string

      Locale preference for taxon common names

    • OptionalonlyId?: boolean

      Return only the record IDs

    • Optionalorder?: "desc" | "asc"

      Sort order

    • OptionalorderBy?: "id" | "created_at" | "observations_count"

      Sort field

    • OptionalparentId?: number

      Taxon's parent must have this ID

    • OptionalperPage?: string

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

    • OptionalpreferredPlaceId?: number

      Place preference for regional taxon common names

    • Optionalq?: string

      Search by name (must start with this value) or by ID (exact match).

    • 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

    • OptionalrankLevel?: number

      Taxon must have this rank level. Some example values are 70 (kingdom), 60 (phylum), 50 (class), 40 (order), 30 (family), 20 (genus), 10 (species), 5 (subspecies)

    • OptionaltaxonId?: string[]

      Only show taxa with this ID, or its descendants

    url: "/taxa"

    Settings

    Member Visibility

    On This Page

    Properties