NatureServe Explorer API

https://explorer.natureserve.org/api-docs
Admin
NatureServe Explorer API provides access to comprehensive biodiversity data about species,...
Tokens:62,538
Snippets:400
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Taxon Search HTTP Request Example

Source: https://explorer.natureserve.org/api-docs/index.html

Example of an HTTP GET request to search for a taxon. Demonstrates the use of ouSeqUid and id parameters. A 404 Not Found response is returned if the ouSeqUid does not exist.

```http
GET /api/data/taxonSearch?ouSeqUid=doesNotExist&id=154701 HTTP/1.1
Accept: application/json
```

--------------------------------

### Data Provider Response Example

Source: https://explorer.natureserve.org/api-docs/index.html

Successful response containing data provider details.

```JSON
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Keep-Alive: timeout=60
Connection: keep-alive

{
  "id" : 2,
  "code" : "US-AK",
  "name" : "Alaska Natural Heritage Program",
  "subnation" : {
    "id" : 1,
    "nameEn" : "Alaska",
    "nameEs" : "Alaska",
    "nameFr" : "Alaska",
    "subnationCode" : "AK",
    "dnationId" : 225
  },
  "websiteUrl" : "https://accs.uaa.alaska.edu",
  "contactEmail" : "foo@example.com",
  "logoUrl" : "https://example.com/logo.png",
  "networkDirectoryId" : 187,
  "bldDataWebsiteUrl" : null,
  "bldDataContactName" : null,
  "bldDataContactEmail" : "jane.doe@example.com",
  "bldDataContactPhone" : null,
  "bldDataContactPhotoUrl" : null,
  "alternativeDataServiceUrl" : null,
  "alternativeDataServiceName" : null,
  "lastUpdated" : "2026-03-11T15:48:12.303679Z",
  "bldDataContactDefined" : true
}
```

--------------------------------

### Taxon Search HTTP Response Example (404 Not Found)

Source: https://explorer.natureserve.org/api-docs/index.html

Example of an HTTP 404 Not Found response for a taxon search when the specified ouSeqUid does not exist.

```http
HTTP/1.1 404 Not Found
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: text/plain;charset=ISO-8859-1
Keep-Alive: timeout=60
Connection: keep-alive

No taxon record found with ouSeqUid=doesNotExist
```

--------------------------------

### Malformed JSON HTTP Request Example

Source: https://explorer.natureserve.org/api-docs/index.html

This example demonstrates an HTTP POST request with malformed JSON content, which would result in an error.

```http
POST /api/data/search HTTP/1.1
Accept: application/json
Content-Type: application/json
Content-Length: 59

{"unexpectedPropertyName":"foo", "criteriaType":"combined"}
```

--------------------------------

### Get Taxon HTTP Request

Source: https://explorer.natureserve.org/api-docs/index.html

Example HTTP request to retrieve taxon information using its Element Global UID. Ensure the Accept header is set to application/json.

```http
GET /api/data/taxon/ELEMENT_GLOBAL.2.154701 HTTP/1.1
Accept: application/json
```

--------------------------------

### Sensitive Taxa Response Example

Source: https://explorer.natureserve.org/api-docs/index.html

Example of a successful 200 OK response containing sensitive taxa data.

```JSON
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Keep-Alive: timeout=60
Connection: keep-alive

[ {
  "dataSensitiveCategory" : {
    "id" : 2,
    "dataSensitiveCategoryDescEn" : "Proprietary Data",
    "dataSensitiveCategoryDescEs" : null,
    "dataSensitiveCategoryDescFr" : null,
    "nsStandardInd" : true
  },
  "taxa" : [ {
    "uniqueId" : "ELEMENT_GLOBAL.2.154701",
    "scientificName" : "Hydrastis canadensis",
    "primaryCommonName" : "Goldenseal",
    "recordType" : "SPECIES"
  } ]
}, {
  "dataSensitiveCategory" : {
    "id" : 3,
    "dataSensitiveCategoryDescEn" : "Land Owner Restrictions",
    "dataSensitiveCategoryDescEs" : null,
    "dataSensitiveCategoryDescFr" : null,
    "nsStandardInd" : true
  },
  "taxa" : [ ]
} ]
```

--------------------------------

### GET /search

Source: https://explorer.natureserve.org/api-docs/index.html

Retrieves a list of species and ecosystem records based on search criteria.

```APIDOC
## GET /search

### Description
Retrieves a collection of species and ecosystem records. The results are returned as an array where each item contains a `recordType` field to distinguish between species and ecosystem data.

### Response
#### Success Response (200)
- **results** (Array) - The search results, which might contain a mixture of species and ecosystem records. These can be distinguished by their **recordType** property.
- **resultsSummary** (Object) - A summary of the results returned

#### Response Example
{
  "results" : [ {
    "recordType" : "SPECIES",
    "scientificName" : "Quercus acerifolia",
    "primaryCommonName" : "Mapleleaf Oak"
  }, {
    "recordType" : "ECOSYSTEM",
    "scientificName" : "Juniperus virginiana - Quercus spp. Ruderal Forest",
    "primaryCommonName" : "Highland Rim Ruderal Red-cedar - Oak Forest"
  } ],
  "resultsSummary" : {
    "page" : 0,
    "recordsPerPage" : 20,
    "totalPages" : 1,
    "totalResults" : 2
  }
}
```

--------------------------------

### HTTP Request to Get Informal Taxonomy

Source: https://explorer.natureserve.org/api-docs/index.html

Use this GET request to retrieve the entire informal taxonomy tree. The response is a JSON array of taxonomy nodes.

```http
GET /api/data/informalTaxonomy HTTP/1.1
Accept: application/json
Content-Type: application/json
```

--------------------------------

### Execute Combined Search Request

Source: https://explorer.natureserve.org/api-docs/index.html

Example of a POST request to the combined search endpoint with base criteria structure.

```http
POST /api/data/search HTTP/1.1
Accept: application/json
Content-Type: application/json
Content-Length: 299

{
  "criteriaType" : "combined",
  "textCriteria" : [ ],
  "statusCriteria" : [ ],
  "locationCriteria" : [ ],
  "pagingOptions" : null,
  "recordSubtypeCriteria" : [ ],
  "modifiedSince" : null,
  "locationOptions" : null,
  "classificationOptions" : null,
  "recordTypeCriteria" : [ ]
}
```

--------------------------------

### HTTP Response Structure

Source: https://explorer.natureserve.org/api-docs/index.html

Example of a successful HTTP 200 response containing species and ecosystem records.

```http
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Keep-Alive: timeout=60
Connection: keep-alive

{
  "results" : [ {
    "recordType" : "SPECIES",
    "elementGlobalId" : 0,
    "uniqueId" : "ELEMENT_GLOBAL.2.129701",
    "nsxUrl" : "/Taxon/ELEMENT_GLOBAL.2.129701/Quercus_acerifolia",
    "elcode" : "PDFAG05350",
    "scientificName" : "Quercus acerifolia",
    "formattedScientificName" : "<i>Quercus acerifolia</i>",
    "primaryCommonName" : "Mapleleaf Oak",
    "primaryCommonNameLanguage" : "EN",
    "roundedGRank" : "G1",
    "nations" : [ {
      "nationCode" : "US",
      "roundedNRank" : "N1",
      "subnations" : [ {
        "subnationCode" : "AR",
        "roundedSRank" : "S1",
        "exotic" : false,
        "native" : true
      }, {
        "subnationCode" : "OK",
        "roundedSRank" : "SNA",
        "exotic" : true,
        "native" : false
      } ],
      "exotic" : true,
      "native" : false
    } ],
    "lastModified" : null,
    "classificationStatus" : null,
    "speciesGlobal" : {
      "usesaCode" : "LE",
      "cosewicCode" : "X",
      "saraCode" : null,
      "synonyms" : [ "Synonym 1", "Synonym 2" ],
      "otherCommonNames" : [ "Common name 1", "Common name 2" ],
      "kingdom" : "Plantae",
      "phylum" : "Anthophyta",
      "taxclass" : "Dicotyledoneae",
      "taxorder" : "Fagales",
      "family" : "Fagaceae",
      "genus" : "Quercus",
      "taxonomicComments" : "<b>Taxonomic comments</b> might include some HTML markup",
      "informalTaxonomy" : "Plants  |  Vascular Plants - Flowering Plants  |  Dicots",
      "infraspecies" : false,
      "completeDistribution" : true
    },
    "gRank" : "G1G2"
  }, {
    "recordType" : "ECOSYSTEM",
    "elementGlobalId" : 0,
    "uniqueId" : "ELEMENT_GLOBAL.2.683214",
    "nsxUrl" : "/Taxon/ELEMENT_GLOBAL.2.683214/Juniperus_virginiana_-_Quercus_spp_Ruderal_Forest",
    "elcode" : "CEGL004731",
    "scientificName" : "Juniperus virginiana - Quercus spp. Ruderal Forest",
    "formattedScientificName" : "<i>Juniperus virginiana - Quercus</i> spp. Ruderal Forest",
    "primaryCommonName" : "Highland Rim Ruderal Red-cedar - Oak Forest",
    "primaryCommonNameLanguage" : "EN",
    "roundedGRank" : "GNA",
    "nations" : [ {
      "nationCode" : "US",
      "roundedNRank" : "NNA",
      "subnations" : [ {
        "subnationCode" : "AL",
        "roundedSRank" : "SNA"
      }, {
        "subnationCode" : "GA",
        "roundedSRank" : "SNA"
      }, {
        "subnationCode" : "KY",
        "roundedSRank" : "SNA"
      }, {
        "subnationCode" : "TN",
        "roundedSRank" : "SNA"
      } ]
    } ],
    "lastModified" : null,
    "classificationStatus" : null,
    "ecosystemGlobal" : {
      "translatedScientificName" : "Eastern Red-cedar - Oak species Ruderal Forest",
      "taxclassCode" : "1",
      "taxsubclassCode" : "1.B",
      "formationCode" : "1.B.2",
      "divisionCode" : "1.B.2.Na",
      "macrogroupKey" : "M013",
      "taxgroupKey" : "G030",
      "allianceKey" : "A3227",
      "ecosystemType" : "ASSOCIATION",
      "classificationCode" : "CEGL004731",
      "parentName" : "Ruderal Eastern Red-cedar - Virginia Pine - Mixed Conifer Forest",
      "ivccTaxclassCode" : null,
      "ivccTaxsubclassCode" : null,
      "ivccFormationCode" : null,
      "ivccSubformationCode" : null,
      "ivccTaxgroupCode" : null,
      "ivccTaxsubgroupCode" : null,
      "ivccTaxtypeCode" : null
    },
    "gRank" : "GNA"
  } ],
  "resultsSummary" : {
    "page" : 0,
    "recordsPerPage" : 20,
    "totalPages" : 1,
    "totalResults" : 2,
    "speciesResults" : {
      "total" : 10
    },
    "ecosystemResults" : {
      "total" : 1,
      "classes" : 0,
      "subclasses" : 0,
      "formations" : 0,
      "divisions" : 0,
      "macrogroups" : 0,
      "groups" : 0,
      "alliances" : 0,
      "associations" : 1,
      "terrestrialEcologicalSystems" : 0,
      "ivccClasses" : 0,
      "ivccSubclasses" : 0,
      "ivccFormations" : 0,
      "ivccSubformations" : 0,
      "ivccGroups" : 0,
      "ivccSubgroups" : 0,
      "ivccTypes" : 0,
      "ivccSubtypes" : 0
    }
  },
  "searchCriteria" : {
    "criteriaType" : "combined",
    "textCriteria" : [ ],
    "statusCriteria" : [ ],
    "locationCriteria" : [ ],
    "pagingOptions" : {
      "page" : 0,
      "recordsPerPage" : 20
    },
    "recordSubtypeCriteria" : [ ],
    "modifiedSince" : null,
    "locationOptions" : null,
    "classificationOptions" : null,
    "recordTypeCriteria" : [ ]
  }
}
```

--------------------------------

### Retrieve Job Status HTTP Response

Source: https://explorer.natureserve.org/api-docs/index.html

Example of a successful HTTP response for a job status request.

```http
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Keep-Alive: timeout=60
Connection: keep-alive

{
  "state" : "Finished",
  "data" : {
    "success" : true,
    "errorMessage" : null,
    "data" : { },
    "url" : "https://explorer-downloads.natureserve.org/shortTerm/explorer/taxaSearchExports/2026-03-11/6d03ee84-069c-49ce-816d-0b38bb2dc008.json"
  },
  "percentComplete" : 100.0,
  "successful" : true,
  "error" : null,
  "group" : "QuartzJobs",
  "timeScheduled" : "2026-03-11T15:51:22.4286121Z",
  "timeStarted" : "2026-03-11T15:51:22.4288621Z",
  "timeFinished" : "2026-03-11T15:51:22.4291121Z",
  "timeLastChecked" : "2026-03-11T15:51:22.4293621Z"
}
```

--------------------------------

### Quick Search Parameter Example

Source: https://explorer.natureserve.org/api-docs/index.html

This JSON object represents a 'quickSearch' parameter for text criteria. It's used for broad searches and matches against 'allNames' and 'code'.

```json
{
  "paramType" : "quickSearch",
  "searchToken" : "foo"
}
```

--------------------------------

### HTTP 200 OK Response

Source: https://explorer.natureserve.org/api-docs/index.html

Example of a successful API response containing detailed taxonomic and conservation status information for a species.

```http
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Keep-Alive: timeout=60
Connection: keep-alive

{
  "elementGlobalId" : 154701,
  "circumscripConfidence" : null,
  "classificationLevel" : {
    "id" : 17,
    "classificationLevelNameEn" : "Species",
    "classificationLevelNameEs" : null,
    "classificationLevelNameFr" : null
  },
  "classificationStatus" : {
    "id" : 1,
    "classificationStatusDescEn" : "Standard",
    "classificationStatusDescEs" : null,
    "classificationStatusDescFr" : null
  },
  "iucn" : {
    "id" : 5,
    "iucnDescEn" : "Vulnerable",
    "iucnDescEs" : null,
    "iucnDescFr" : null,
    "iucnCode" : "VU"
  },
  "nameCategory" : {
    "id" : 4,
    "nameCategoryDescEn" : "Vascular Plant",
    "nameCategoryDescEs" : "Planta vascular",
    "nameCategoryDescFr" : "Plante vasculaire",
    "nameTypeCd" : "P",
    "nameTypeDesc" : "Botanical"
  },
  "rankMethodUsed" : {
    "id" : 1,
    "rankMethodUsedDescEn" : "Rank calculator v.3.1x - 2011-2015 rank factors",
    "rankMethodUsedDescEs" : null,
    "rankMethodUsedDescFr" : null,
    "rankMethodUsedExternalDescEn" : null,
    "rankMethodUsedExternalDescEs" : null,
    "rankMethodUsedExternalDescFr" : null
  },
  "formattedScientificName" : "<i>Hydrastis canadensis</i>",
  "scientificName" : "Hydrastis canadensis",
  "scientificNameAuthor" : "L.",
  "primaryCommonName" : "Goldenseal",
  "relatedItisNames" : "<i>Hydrastis canadensis</i> L. (TSN 18781)",
  "uniqueId" : "ELEMENT_GLOBAL.2.154701",
  "elcode" : "PDRAN0F010",
  "conceptRefFullCitation" : "Kartesz, J.T. 1994. A synonymized checklist of the vascular flora of the United States, Canada, and Greenland. 2nd edition. 2 vols. Timber Press, Portland, OR.",
  "conceptName" : "<i>Hydrastis canadensis</i>",
  "taxonomicComments" : "<i>Hydrastis canadensis</i> occurs in eastern North America and is a monotypic genus. In the most current taxonomic revision <i>Hydrastis </i>is placed in Hydrastidaceae, with one other monotypic genus, <i>Glaucidium,</i> which is restricted to Japan (Tobe 2003).",
  "roundedGRank" : "G3",
  "conservationStatusFactorsEditionDate" : "2013-04-29",
  "conservationStatusFactorsEditionAuthors" : "Oliver, L.",
  "primaryCommonNameLanguage" : "EN",
  "recordType" : "SPECIES",
  "elementNationals" : [ {
    "elementNationalId" : 211679,
    "classifConfidence" : null,
    "nation" : {
      "id" : 225,
      "nameEn" : "United States",
      "nameEs" : null,
      "nameFr" : null,
      "isoCode" : "US",
      "region" : null
    },
    "roundedNRank" : "N3",
    "elementSubnationals" : [ {
      "elementSubnationalId" : 380016,
      "subnation" : {
        "id" : 25,
        "nameEn" : "Maryland",
        "nameEs" : null,
        "nameFr" : null,
        "subnationCode" : "MD",
        "dnationId" : 225
      },
      "roundedSRank" : "S2",
      "dataSensitive" : {
        "id" : 1,
        "dataSensitiveDescEn" : "Yes",
        "dataSensitiveDescEs" : null,
        "dataSensitiveDescFr" : null,
        "dataSensitiveCode" : "Y"
      },
      "dataSensitiveCategory" : {
        "id" : 2,
        "dataSensitiveCategoryDescEn" : "Proprietary Data",
        "dataSensitiveCategoryDescEs" : null,
        "dataSensitiveCategoryDescFr" : null,
        "nsStandardInd" : true
      },
      "srank" : "S2",
      "speciesSubnational" : {
        "elementSubnationalId" : 380016,
        "hybrid" : false,
        "exotic" : false,
        "native" : true
      }
    }, {
      "elementSubnationalId" : 557226,
      "subnation" : {
        "id" : 11,
        "nameEn" : "Delaware",
        "nameEs" : null,
        "nameFr" : null,
        "subnationCode" : "DE",
        "dnationId" : 225
      },
      "roundedSRank" : "S3",
      "dataSensitive" : {
        "id" : 1,
        "dataSensitiveDescEn" : "Yes",
        "dataSensitiveDescEs" : null,
        "dataSensitiveDescFr" : null,
        "dataSensitiveCode" : "Y"
      },
      "dataSensitiveCategory" : {
        "id" : 2,
        "dataSensitiveCategoryDescEn" : "Proprietary Data",
        "dataSensitiveCategoryDescEs" : null,
        "dataSensitiveCategoryDescFr" : null,
        "nsStandardInd" : true
      },
      "srank" : "S3",
      "speciesSubnational" : {
        "elementSubnationalId" : 557226,
        "hybrid" : false,
        "exotic" : false,
        "native" : true
      }
    }, {
      "elementSubnationalId" : 416745,
      "subnation" : {
        "id" : 23,
        "nameEn" : "Louisiana",
        "nameEs" : null,
        "nameFr" : null,
        "subnationCode" : "LA",
        "dnationId" : 225
      },
      "roundedSRank" : "SNA",
      "dataSensitive" : {
        "id" : 1,
        "dataSensitiveDescEn" : "Yes",
        "dataSensitiveDescEs" : null,
        "dataSensitiveDescFr" : null,
        "dataSensitiveCode" : "Y"
      },
      "dataSensitiveCategory" : {
        "id" : 2,
        "dataSensitiveCategoryDescEn" : "Proprietary Data",
        "dataSensitiveCategoryDescEs" : null,
        "dataSensitiveCategoryDescFr" : null,
        "nsStandardInd" : true
      },
      "srank" : "SNA",
      "speciesSubnational" : {
        "elementSubnationalId" : 416745,
        "hybrid" : false,
        "exotic" : false,
        "native" : true
      }
    }
  ]
}
```

--------------------------------

### Retrieve Nations HTTP Response

Source: https://explorer.natureserve.org/api-docs/index.html

Example response containing an array of nation objects and their subnation status.

```http
HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Keep-Alive: timeout=60
Connection: keep-alive

[ {
  "nation" : {
    "id" : 38,
    "nameEn" : "Canada",
    "nameEs" : null,
    "nameFr" : null,
    "isoCode" : "CA",
    "region" : "Canada"
  },
  "hasSubnations" : true
}, {
  "nation" : {
    "id" : 139,
    "nameEn" : "Mexico",
    "nameEs" : null,
    "nameFr" : null,
    "isoCode" : "MX",
    "region" : "Mexico"
  },
  "hasSubnations" : false
}, {
  "nation" : {
    "id" : 225,
    "nameEn" : "United States",
    "nameEs" : null,
    "nameFr" : null,
    "isoCode" : "US",
    "region" : null
  },
  "hasSubnations" : true
} ]
```

--------------------------------

### Get Ecosystem Hierarchy

Source: https://explorer.natureserve.org/api-docs/index.html

Retrieves the hierarchical structure of ecosystems.

```APIDOC
## GET /api/data/ecosystemHierarchy

### Description
Retrieves the hierarchical structure of ecosystems.

### Method
GET

### Endpoint
/api/data/ecosystemHierarchy

### Parameters
#### Query Parameters
- **id** (integer) - Required - The ID of the ecosystem to retrieve the hierarchy for.

### Request Example
```
GET /api/data/ecosystemHierarchy?id=1 HTTP/1.1
Accept: application/json
```

### Response
#### Success Response (200)
- **[Response fields will vary based on the ecosystem hierarchy found]**

#### Error Response (404)
- **message** (string) - Description of the error, e.g., "Ecosystem not found."
```

--------------------------------

### Get Taxon

Source: https://explorer.natureserve.org/api-docs/index.html

Retrieves information about a specific taxon using its Element Global UID.

```APIDOC
## GET /api/data/taxon/{ouSeqUid}

### Description
Retrieves detailed information for a specific taxon identified by its unique UID.

### Method
GET

### Endpoint
/api/data/taxon/{ouSeqUid}

### Parameters
#### Path Parameters
- **ouSeqUid** (string) - Required - The taxon’s Element Global UID.

### Request Example
```http
GET /api/data/taxon/ELEMENT_GLOBAL.2.154701 HTTP/1.1
Accept: application/json
```

### Response
#### Success Response (200)
- **taxonData** (object) - Contains the detailed information about the taxon.

#### Response Example
```json
{
  "taxonData": {
    "scientificName": "Example Species",
    "commonName": "Example Common Name",
    "rank": "Species",
    "uid": "ELEMENT_GLOBAL.2.154701"
  }
}
```
```

--------------------------------

### GET /api/dataProvider/{code}

Source: https://explorer.natureserve.org/api-docs/index.html

Retrieves detailed information about a specific data provider based on their unique code.

```APIDOC
## GET /api/dataProvider/{code}

### Description
Returns information about the data providers for spatial records displayed on the site maps.

### Method
GET

### Endpoint
/api/dataProvider/{code}

### Parameters
#### Path Parameters
- **code** (String) - Required - The data provider’s unique code.

### Response
#### Success Response (200)
- **id** (Integer) - Provider ID.
- **code** (String) - Provider code.
- **name** (String) - Provider name.
- **websiteUrl** (String) - Official website URL.

#### Response Example
{
  "id": 2,
  "code": "US-AK",
  "name": "Alaska Natural Heritage Program",
  "websiteUrl": "https://accs.uaa.alaska.edu"
}
```

--------------------------------

### Query Layer Count

Source: https://explorer.natureserve.org/api-docs/index.html

This example demonstrates how to query a layer within a feature service to count the number of features, which can be used to check if data is available for a taxon.

```APIDOC
## GET /explorer-maps/{SERVICE_NAME}/{OU_SEQ_UID}/FeatureServer/{LAYER_ID}/query

### Description
Query a specific layer within a feature service to count the number of features. This is useful for determining if data exists for a given taxon.

### Method
GET

### Endpoint
/explorer-maps/{SERVICE_NAME}/{OU_SEQ_UID}/FeatureServer/{LAYER_ID}/query

### Parameters
#### Path Parameters
- **SERVICE_NAME** (string) - Required - The name of the specific feature service (e.g., `species_subnational_ranks`).
- **OU_SEQ_UID** (string) - Required - The unique identifier of a taxon (e.g., `ELEMENT_GLOBAL.2.102187`).
- **LAYER_ID** (string) - Required - The ID of the layer to query (e.g., `0`).

#### Query Parameters
- **returnCountOnly** (boolean) - Required - Set to `true` to only return the count of features.

### Request Example
```json
{
  "example": "https://explorer.natureserve.org/explorer-maps/species_subnational_ranks/ELEMENT_GLOBAL.2.102187/FeatureServer/0/query/?returnCountOnly=true"
}
```

### Response
#### Success Response (200)
- **count** (integer) - The number of features in the layer.

#### Response Example
```json
{
  "example": "{\"count\": 15}"
}
```
```

--------------------------------

### HTTP POST Request for Data Search

Source: https://explorer.natureserve.org/api-docs/index.html

This is an example of an HTTP POST request to the /api/data/search endpoint. It includes common headers and a JSON body for specifying search criteria.

```http
POST /api/data/search HTTP/1.1
Accept: application/json
Content-Type: application/json
Content-Length: 350

{
  "criteriaType" : "combined",
  "textCriteria" : [ ],
  "statusCriteria" : [ ],
  "locationCriteria" : [ ],
  "pagingOptions" : {
    "page" : null,
    "recordsPerPage" : null
  },
  "recordSubtypeCriteria" : [ ],
  "modifiedSince" : null,
  "locationOptions" : null,
  "classificationOptions" : null,
  "recordTypeCriteria" : [ ]
}
```

--------------------------------

### Get Taxon by Element Global UID

Source: https://explorer.natureserve.org/api-docs/index.html

Retrieves taxon information using its Element Global UID. Ensure the UID is correctly formatted.

```http
GET /api/data/taxonSearch?ouSeqUid=ELEMENT_GLOBAL.2.154701 HTTP/1.1
Accept: application/json
```

--------------------------------

### GET /api/data/informalTaxonomy

Source: https://explorer.natureserve.org/api-docs/index.html

Retrieves the entire informal taxonomy tree, represented as a list of nodes, where each node contains a name and an array of subnodes.

```APIDOC
## GET /api/data/informalTaxonomy

### Description
Retrieves the entire informal taxonomy tree.

### Method
GET

### Endpoint
/api/data/informalTaxonomy

### Request Example
```http
GET /api/data/informalTaxonomy HTTP/1.1
Accept: application/json
Content-Type: application/json
```

### Response
#### Success Response (200)
- **Array** - Array of Informal Taxonomy Domain objects. See Informal Taxonomy Domain Object for details.

#### Informal Taxonomy Domain Object
```json
{
  "name" : "Animals",
  "subnodes" : [
    {
      "name" : "Vertebrates",
      "subnodes" : [
        {
          "name" : "Mammals",
          "subnodes" : []
        }
      ]
    }
  ]
}
```

#### Informal Taxonomy Domain Object Fields
- **name** (String) - Informal Taxonomy name.
- **subnodes** (Array) - Array of Informal Taxonomy objects.
```

--------------------------------

### Configure Paging Options

Source: https://explorer.natureserve.org/api-docs/index.html

Settings to control pagination of search results, with a maximum of 100 records per page.

```json
{
  "page" : 0,
  "recordsPerPage" : 20
}
```

--------------------------------

### Get Job Status Request

Source: https://explorer.natureserve.org/api-docs/index.html

GET request to retrieve the status of a specific export job using its ID.

```HTTP
GET /api/job/6d03ee84-069c-49ce-816d-0b38bb2dc008 HTTP/1.1
Accept: application/json
Content-Type: application/json
```

--------------------------------

### Request Subnations Data

Source: https://explorer.natureserve.org/api-docs/index.html

GET request to retrieve subnations for a specific nation code.

```http
GET /api/data/subnations/US HTTP/1.1
Accept: application/json
Content-Type: application/json
```

--------------------------------

### GET /api/job/{jobId}

Source: https://explorer.natureserve.org/api-docs/index.html

Retrieves the status of a job using its unique job ID.

```APIDOC
## GET /api/job/{jobId}

### Description
The job web service is used to get the status of a job. The web service accepts a GET request, where the job id is a path variable. The service returns a JSON object that includes the status of the job.

### Method
GET

### Endpoint
/api/job/{jobId}

### Parameters
#### Path Parameters
- **jobId** (String) - Required - The Job Id

### Request Example
```
GET /api/job/6d03ee84-069c-49ce-816d-0b38bb2dc008 HTTP/1.1
Accept: application/json
Content-Type: application/json
```
```

--------------------------------

### Configure Classification Options

Source: https://explorer.natureserve.org/api-docs/index.html

Optional settings to include infraspecies, provisional, or nonstandard taxonomy in search results.

```json
{
  "includeInfraspecies" : true,
  "includeProvisional" : true,
  "includeNonstandard" : true
}
```

--------------------------------

### Handle Invalid Ecosystem ID

Source: https://explorer.natureserve.org/api-docs/index.html

Requesting an ecosystem ID that does not exist results in a 404 error.

```http
GET /api/data/ecosystemHierarchy/doesNotExist HTTP/1.1
Accept: application/json
```

--------------------------------

### POST /api/data/search

Source: https://explorer.natureserve.org/api-docs/index.html

Example of a common error response when sending malformed JSON to the search endpoint.

```APIDOC
## POST /api/data/search

### Description
Example of a request that triggers a malformed JSON error.

### Method
POST

### Endpoint
/api/data/search

### Request Example
{
  "unexpectedPropertyName": "foo",
  "criteriaType": "combined"
}
```

--------------------------------

### Paging Options

Source: https://explorer.natureserve.org/api-docs/index.html

Options to control pagination of search results.

```APIDOC
## Paging Options

### Description
Controls the pagination of search results.

### Request Body Example
```json
{
  "page" : 0,
  "recordsPerPage" : 20
}
```

### Parameters
#### Request Body
- **page** (Number) - Optional - Zero-indexed page number; default value is 0.
- **recordsPerPage** (Number) - Optional - Records per page; default value is 20. Maximum value is 100.
```

--------------------------------

### GET /api/data/sensitiveTaxa/byCategory

Source: https://explorer.natureserve.org/api-docs/index.html

Retrieves a list of sensitive taxa filtered by category, subnation, nation, and record type.

```APIDOC
## GET /api/data/sensitiveTaxa/byCategory

### Description
Retrieves sensitive taxa information grouped by data sensitive category for a specified subnation and nation.

### Method
GET

### Endpoint
/api/data/sensitiveTaxa/byCategory

### Parameters
#### Query Parameters
- **subnation** (String) - Required - The subnation code (e.g., ON).
- **nation** (String) - Required - The nation code (e.g., CA).
- **recordType** (String) - Required - The record type (e.g., SPECIES).
- **dataSensitiveCategoryIds** (String) - Required - Comma-separated list of category IDs.

### Response
#### Success Response (200)
- **dataSensitiveCategory** (Object) - Data Sensitive Category domain object.
- **taxa[]** (Array) - List of elements matching the category.
- **taxa[].uniqueId** (String) - The record’s primary unique identifier.
- **taxa[].scientificName** (String) - The scientific name.
- **taxa[].primaryCommonName** (String) - The primary common name.
- **taxa[].recordType** (String) - Record type (SPECIES or ECOSYSTEM).

#### Response Example
[
  {
    "dataSensitiveCategory": {
      "id": 2,
      "dataSensitiveCategoryDescEn": "Proprietary Data",
      "nsStandardInd": true
    },
    "taxa": [
      {
        "uniqueId": "ELEMENT_GLOBAL.2.154701",
        "scientificName": "Hydrastis canadensis",
        "primaryCommonName": "Goldenseal",
        "recordType": "SPECIES"
      }
    ]
  }
]
```

--------------------------------

### GET /api/data/ecosystemHierarchy/{ouSeqUid}

Source: https://explorer.natureserve.org/api-docs/index.html

Retrieves the upper-level hierarchy for an ecosystem record identified by its Element Global UID.

```APIDOC
## GET /api/data/ecosystemHierarchy/{ouSeqUid}

### Description
Summarizes the upper-level hierarchy for an Ecosystem record. Results vary based on the provided ID type (Association, Group, or Terrestrial Ecological System).

### Method
GET

### Endpoint
/api/data/ecosystemHierarchy/{ouSeqUid}

### Parameters
#### Path Parameters
- **ouSeqUid** (string) - Required - The taxon’s Element Global UID.

### Response
#### Success Response (200)
- **uniqueId** (string) - The Global UID of the record.
- **name** (string) - The name of the ecosystem level.
- **nsxUrl** (string) - The URL for the entry in Explorer.
- **ecosystemType** (string) - The classification level (e.g., CLASS, ALLIANCE).
- **classificationCode** (string) - The hierarchical code.

#### Response Example
[
  {
    "uniqueId": "ELEMENT_GLOBAL.2.899395",
    "name": "Pinus echinata - Quercus stellata - Quercus velutina Ozark-Ouachita Woodland Alliance",
    "nsxUrl": "/Taxon/ELEMENT_GLOBAL.2.899395/Ozark-Ouachita_Shortleaf_Pine_-_Oak_Woodland",
    "ecosystemType": "ALLIANCE",
    "classificationCode": "A3271"
  }
]
```

--------------------------------

### GET /api/data/taxonSearch

Source: https://explorer.natureserve.org/api-docs/index.html

Retrieves taxon information using an alternate key, specifically the Element Global UID.

```APIDOC
## GET /api/data/taxonSearch

### Description
This service allows a taxon to be retrieved using an alternate key with a unique value. It returns detailed taxon data including habitat information and global threat assessments.

### Method
GET

### Endpoint
/api/data/taxonSearch

### Parameters
#### Query Parameters
- **ouSeqUid** (string) - Required - The taxon’s Element Global UID

### Request Example
GET /api/data/taxonSearch?ouSeqUid=ELEMENT_GLOBAL.2.154701 HTTP/1.1
Accept: application/json

### Response
#### Success Response (200)
- **speciesTerrestrialHabitats** (array) - List of terrestrial habitats associated with the taxon
- **elementGlobalThreatAssessments** (array) - List of global threat assessments including IUCN categories, scope, severity, and timing
```

--------------------------------

### Species Characteristics and Global Data Model

Source: https://explorer.natureserve.org/api-docs/index.html

This section defines the structure for species habitat characteristics and global taxonomic metadata.

```APIDOC
## Species Data Structure

### Description
Provides the schema for species habitat definitions and global taxonomic classification details.

### Parameters
#### Response Fields
- **speciesCharacteristics.speciesMarineHabitats** (Array) - Marine habitat classifications.
- **speciesCharacteristics.speciesPalustrineHabitats** (Array) - Palustrine habitat classifications.
- **speciesCharacteristics.speciesRiverineHabitats** (Array) - Riverine habitat classifications.
- **speciesCharacteristics.speciesSubterraneanHabitats** (Array) - Subterranean habitat classifications (Animal only).
- **speciesCharacteristics.speciesTerrestrialHabitats** (Array) - Terrestrial habitat classifications.
- **speciesGlobal.kingdom** (String) - Kingdom classification.
- **speciesGlobal.phylum** (String) - Phylum classification.
- **speciesGlobal.taxclass** (String) - Class classification.
- **speciesGlobal.taxorder** (String) - Order classification.
- **speciesGlobal.family** (String) - Family classification.
- **speciesGlobal.genus** (String) - Genus classification.
- **speciesGlobal.infraspecies** (Boolean) - Indicates if the record is a sub-species or variety.
- **speciesGlobal.parentSpecies** (Object) - Details of the parent species if applicable.
- **speciesGlobal.cosewic** (Object) - COSEWIC status information.
```

--------------------------------

### GET /api/data/sensitiveTaxa/byCategory

Source: https://explorer.natureserve.org/api-docs/index.html

Retrieves an array of taxa data grouped by data sensitive category within a specific subnation.

```APIDOC
## GET /api/data/sensitiveTaxa/byCategory

### Description
This service returns an array of taxa data grouped by data sensitive category within the given subnation.

### Method
GET

### Endpoint
/api/data/sensitiveTaxa/byCategory

### Parameters
#### Query Parameters
- **subnation** (String) - Required - Subnation code.
- **nation** (String) - Required - Nation code.
- **recordType** (String) - Optional - The type of records to return. Supported values: SPECIES, ECOSYSTEM.
- **dataSensitiveCategoryIds** (Array of Integers) - Optional - Limits the returned taxa to those which have the specified data sensitive categories.
```

--------------------------------

### GET /api/data/sensitiveTaxa

Source: https://explorer.natureserve.org/api-docs/index.html

Retrieves an array of taxa data that are classified as Sensitive or Conditionally Sensitive within a specific subnation.

```APIDOC
## GET /api/data/sensitiveTaxa

### Description
This service returns an array of taxa data which are Sensitive or Conditionally Sensitive within the given subnation.

### Method
GET

### Endpoint
/api/data/sensitiveTaxa

### Parameters
#### Query Parameters
- **subnation** (String) - Required - Subnation code.
- **nation** (String) - Required - Nation code.
- **recordType** (String) - Optional - The type of records to return. Supported values: SPECIES, ECOSYSTEM.

### Request Example
GET /api/data/sensitiveTaxa?subnation=ON&nation=CA&recordType=SPECIES

### Response
#### Success Response (200)
- **uniqueId** (String) - The record’s primary unique identifier
- **scientificName** (String) - The scientific name
- **primaryCommonName** (String) - The primary common name
- **recordType** (String) - Record type (SPECIES or ECOSYSTEM)
- **dataSensitive** (Object) - Data Sensitive domain object
- **dataSensitiveCategory** (Object) - Data Sensitive Category domain object

#### Response Example
[
  {
    "uniqueId": "ELEMENT_GLOBAL.2.154701",
    "scientificName": "Hydrastis canadensis",
    "primaryCommonName": "Goldenseal",
    "recordType": "SPECIES",
    "dataSensitive": {
      "id": 1,
      "dataSensitiveDescEn": "Yes",
      "dataSensitiveCode": "Y"
    },
    "dataSensitiveCategory": {
      "id": 2,
      "dataSensitiveCategoryDescEn": "Proprietary Data",
      "nsStandardInd": true
    }
  }
]
```

--------------------------------

### NatureServe Explorer Data Model

Source: https://explorer.natureserve.org/api-docs/index.html

Overview of the data fields available for taxon and ecosystem records within the NatureServe Explorer API.

```APIDOC
## Data Model Fields

### Description
This section outlines the primary fields available for records returned by the NatureServe Explorer API.

### Fields
- **elcode** (String) - NatureServe Element Code.
- **elementGlobalId** (Integer) - Primary Key for Row.
- **formattedScientificName** (String) - Scientific Name (may contain HTML).
- **grank** (String) - Global Status.
- **primaryCommonName** (String) - Common Name.
- **recordType** (RecordType) - The type of taxon record (SPECIES, ECOSYSTEM).
- **scientificName** (String) - Scientific name with HTML formatting removed.
- **uniqueId** (String) - NatureServe Unique Identifier.
```

--------------------------------

### Species Characteristics Data Model

Source: https://explorer.natureserve.org/api-docs/index.html

Defines the structure for species habitat classifications and global taxonomic metadata.

```APIDOC
## Species Characteristics Data Structure

### Description
This model represents the habitat associations and global taxonomic classification for species records.

### Data Fields
- **speciesCharacteristics.speciesLacustrineHabitats** (Array) - List of lacustrine habitats.
  - **cagLacusHabId** (Integer) - Primary Key.
  - **lacustrineHabitat** (Domain Value) - Habitat value.
- **speciesCharacteristics.speciesMarineHabitats** (Array) - List of marine habitats.
- **speciesCharacteristics.speciesPalustrineHabitats** (Array) - List of palustrine habitats.
- **speciesCharacteristics.speciesRiverineHabitats** (Array) - List of riverine habitats.
- **speciesCharacteristics.speciesSubterraneanHabitats** (Array) - List of subterranean habitats (Animal only).
- **speciesCharacteristics.speciesTerrestrialHabitats** (Array) - List of terrestrial habitats.

### Global Taxonomy Fields
- **speciesGlobal.kingdom** (String) - Kingdom.
- **speciesGlobal.phylum** (String) - Phylum.
- **speciesGlobal.taxclass** (String) - Class.
- **speciesGlobal.taxorder** (String) - Order.
- **speciesGlobal.family** (String) - Family.
- **speciesGlobal.genus** (String) - Genus.
- **speciesGlobal.infraspecies** (Boolean) - Infraspecies Indicator.
- **speciesGlobal.americanFisheriesStatus** (String) - AFS Status.
- **speciesGlobal.cosewic** (Domain Value) - COSEWIC status information.
```
Tokens:
Raw