WoRMS REST Webservice

https://www.marinespecies.org/rest/
Admin
WoRMS REST Webservice provides programmatic access to the World Register of Marine Species database...
Tokens:7,647
Snippets:70
Trust Score:9.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET /AphiaVernacularsByAphiaID/{ID}

Source: https://www.marinespecies.org/rest

Get all vernaculars for a given AphiaID.

```APIDOC
## GET /AphiaVernacularsByAphiaID/{ID}

### Description
Get all vernaculars for a given AphiaID.

### Method
GET

### Endpoint
/AphiaVernacularsByAphiaID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The AphiaID of the taxon.

```

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

### GET /AphiaSynonymsByAphiaID/{ID}

Source: https://www.marinespecies.org/rest

Get all synonyms for a given AphiaID.

```APIDOC
## GET /AphiaSynonymsByAphiaID/{ID}

### Description
Get all synonyms for a given AphiaID.

### Method
GET

### Endpoint
/AphiaSynonymsByAphiaID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The AphiaID of the taxon.

```

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

### GET /AphiaTaxonRanksByName/{taxonRank}

Source: https://www.marinespecies.org/rest

Get taxonomic ranks by their name.

```APIDOC
## GET /AphiaTaxonRanksByName/{taxonRank}

### Description
Get taxonomic ranks by their name.

### Method
GET

### Endpoint
/AphiaTaxonRanksByName/{taxonRank}

### Parameters
#### Path Parameters
- **taxonRank** (string) - Required - The name of the taxonomic rank.

```

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

### GET /AphiaNameByAphiaID/{ID}

Source: https://www.marinespecies.org/rest

Get the name for a given AphiaID.

```APIDOC
## GET /AphiaNameByAphiaID/{ID}

### Description
Get the name for a given AphiaID.

### Method
GET

### Endpoint
/AphiaNameByAphiaID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The AphiaID of the taxon.

```

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

### GET /AphiaRecordByAphiaID/{ID}

Source: https://www.marinespecies.org/rest

Get the complete AphiaRecord for a given AphiaID.

```APIDOC
## GET /AphiaRecordByAphiaID/{ID}

### Description
Get the complete AphiaRecord for a given AphiaID.

### Method
GET

### Endpoint
/AphiaRecordByAphiaID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The AphiaID of the taxon.

```

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

### GET /AphiaSourcesByAphiaID/{ID}

Source: https://www.marinespecies.org/rest

Get one or more sources/references including links, for one AphiaID.

```APIDOC
## GET /AphiaSourcesByAphiaID/{ID}

### Description
Get one or more sources/references including links, for one AphiaID.

### Method
GET

### Endpoint
/AphiaSourcesByAphiaID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The AphiaID of the taxon.

```

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

### GET /AjaxAphiaRecordsByNamePart/{NamePart}

Source: https://www.marinespecies.org/rest

Get taxa suggestion for a given prefix of a taxon name.

```APIDOC
## GET /AjaxAphiaRecordsByNamePart/{NamePart}

### Description
Get taxa suggestion for a given prefix of a taxon name.

### Method
GET

### Endpoint
/AjaxAphiaRecordsByNamePart/{NamePart}

### Parameters
#### Path Parameters
- **NamePart** (string) - Required - The prefix of a taxon name.

```

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

### GET /AphiaDistributionsByAphiaID/{ID}

Source: https://www.marinespecies.org/rest

Get all distributions for a given AphiaID.

```APIDOC
## GET /AphiaDistributionsByAphiaID/{ID}

### Description
Get all distributions for a given AphiaID.

### Method
GET

### Endpoint
/AphiaDistributionsByAphiaID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The AphiaID of the taxon.

```

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

### GET /AphiaAttributeKeysByID/{ID}

Source: https://www.marinespecies.org/rest

Get attribute definitions.

```APIDOC
## GET /AphiaAttributeKeysByID/{ID}

### Description
Get attribute definitions.

### Method
GET

### Endpoint
/AphiaAttributeKeysByID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The attribute definition ID.

```

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

### GET /AphiaRecordFullByAphiaID/{ID}

Source: https://www.marinespecies.org/rest

Get the complete AphiaFullRecord for a given AphiaID.

```APIDOC
## GET /AphiaRecordFullByAphiaID/{ID}

### Description
Get the complete AphiaFullRecord for a given AphiaID.

### Method
GET

### Endpoint
/AphiaRecordFullByAphiaID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The AphiaID of the taxon.

```

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

### GET /AphiaAttributesByAphiaID/{ID}

Source: https://www.marinespecies.org/rest

Get a list of attributes for a given AphiaID.

```APIDOC
## GET /AphiaAttributesByAphiaID/{ID}

### Description
Get a list of attributes for a given AphiaID.

### Method
GET

### Endpoint
/AphiaAttributesByAphiaID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The AphiaID of the taxon.

```

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

### GET /AphiaTaxonRanksByID/{ID}

Source: https://www.marinespecies.org/rest

Get taxonomic ranks by their identifier.

```APIDOC
## GET /AphiaTaxonRanksByID/{ID}

### Description
Get taxonomic ranks by their identifier.

### Method
GET

### Endpoint
/AphiaTaxonRanksByID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The taxon rank identifier.

```

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

### GET /AphiaIDByName/{ScientificName}

Source: https://www.marinespecies.org/rest

Get the AphiaID for a given name.

```APIDOC
## GET /AphiaIDByName/{ScientificName}

### Description
Get the AphiaID for a given name.

### Method
GET

### Endpoint
/AphiaIDByName/{ScientificName}

### Parameters
#### Path Parameters
- **ScientificName** (string) - Required - The scientific name of the taxon.

```

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

### GET /AphiaRecordsByMatchNames

Source: https://www.marinespecies.org/rest

Try to find AphiaRecords using the TAXAMATCH fuzzy matching algorithm by Tony Rees.

```APIDOC
## GET /AphiaRecordsByMatchNames

### Description
Try to find AphiaRecords using the TAXAMATCH fuzzy matching algorithm by Tony Rees.

### Method
GET

### Endpoint
/AphiaRecordsByMatchNames

### Parameters
#### Query Parameters
- **scientificnames** (array of strings) - Required - List of scientific names to match.

```

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

### GET /AphiaRecordsByAphiaIDs

Source: https://www.marinespecies.org/rest

Get an AphiaRecord for multiple AphiaIDs in one go (max: 50).

```APIDOC
## GET /AphiaRecordsByAphiaIDs

### Description
Get an AphiaRecord for multiple AphiaIDs in one go (max: 50).

### Method
GET

### Endpoint
/AphiaRecordsByAphiaIDs

### Parameters
#### Query Parameters
- **aphiaids** (array of integers) - Required - List of AphiaIDs (max 50).

```

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

### GET /AphiaExternalIDByAphiaID/{ID}

Source: https://www.marinespecies.org/rest

Get any external identifier(s) for a given AphiaID.

```APIDOC
## GET /AphiaExternalIDByAphiaID/{ID}

### Description
Get any external identifier(s) for a given AphiaID.

### Method
GET

### Endpoint
/AphiaExternalIDByAphiaID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The AphiaID of the taxon.

```

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

### GET /AphiaRecordsByTaxonRankID/{ID}

Source: https://www.marinespecies.org/rest

Get the AphiaRecords for a given taxonRankID (max 50).

```APIDOC
## GET /AphiaRecordsByTaxonRankID/{ID}

### Description
Get the AphiaRecords for a given taxonRankID (max 50).

### Method
GET

### Endpoint
/AphiaRecordsByTaxonRankID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The taxonRankID.

```

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

### GET /AphiaRecordsByName/{ScientificName}

Source: https://www.marinespecies.org/rest

Get one or more matching (max. 50) AphiaRecords for a given name.

```APIDOC
## GET /AphiaRecordsByName/{ScientificName}

### Description
Get one or more matching (max. 50) AphiaRecords for a given name.

### Method
GET

### Endpoint
/AphiaRecordsByName/{ScientificName}

### Parameters
#### Path Parameters
- **ScientificName** (string) - Required - The scientific name of the taxon.

```

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

### GET /AphiaChildrenByAphiaID/{ID}

Source: https://www.marinespecies.org/rest

Get the direct children (max. 50) for a given AphiaID.

```APIDOC
## GET /AphiaChildrenByAphiaID/{ID}

### Description
Get the direct children (max. 50) for a given AphiaID.

### Method
GET

### Endpoint
/AphiaChildrenByAphiaID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The AphiaID of the taxon.

```

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

### GET /AphiaRecordsByVernacular/{Vernacular}

Source: https://www.marinespecies.org/rest

Get one or more Aphia Records (max. 50) for a given vernacular.

```APIDOC
## GET /AphiaRecordsByVernacular/{Vernacular}

### Description
Get one or more Aphia Records (max. 50) for a given vernacular.

### Method
GET

### Endpoint
/AphiaRecordsByVernacular/{Vernacular}

### Parameters
#### Path Parameters
- **Vernacular** (string) - Required - The vernacular name.

```

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

### GET /AphiaRecordFullByAphiaID/{ID}

Source: https://www.marinespecies.org/rest/api-docs/openapi.yaml

Returns the linked open data implementation of an AphiaRecord for a given AphiaID. There are multiple formats available that can be chosen with the Accept header. The default format is JSON-LD but RDF, Turtle and N-triples are also supported.

```APIDOC
## GET /AphiaRecordFullByAphiaID/{ID}

### Description
Returns the linked open data implementation of an AphiaRecord for a given AphiaID. There are multiple formats available that can be chosen with the Accept header. The default format is JSON-LD but RDF, Turtle and N-triples are also supported.

### Method
GET

### Endpoint
/AphiaRecordFullByAphiaID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The AphiaID to search for

### Response
#### Success Response (200)
- **application/ld+json** - Successful operation
- **application/rdf+xml** - Successful operation
- **text/turtle** - Successful operation
- **application/n-triples** - Successful operation

#### Error Responses
- **204** - Nothing found
- **400** - Bad or missing properties
```

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

### GET /AphiaIDsByAttributeKeyID/{ID}

Source: https://www.marinespecies.org/rest

Get a list of AphiaID's (max 50) with attribute tree for a given attribute definition ID.

```APIDOC
## GET /AphiaIDsByAttributeKeyID/{ID}

### Description
Get a list of AphiaID's (max 50) with attribute tree for a given attribute definition ID.

### Method
GET

### Endpoint
/AphiaIDsByAttributeKeyID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The attribute definition ID.

```

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

### GET /AphiaAttributeValuesByCategoryID/{ID}

Source: https://www.marinespecies.org/rest

Get list values that are grouped by a CategoryID.

```APIDOC
## GET /AphiaAttributeValuesByCategoryID/{ID}

### Description
Get list values that are grouped by a CategoryID.

### Method
GET

### Endpoint
/AphiaAttributeValuesByCategoryID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The CategoryID.

```

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

### GET /AphiaRecordsByNames

Source: https://www.marinespecies.org/rest

For each given scientific name, try to find one or more AphiaRecords.

```APIDOC
## GET /AphiaRecordsByNames

### Description
For each given scientific name, try to find one or more AphiaRecords.

### Method
GET

### Endpoint
/AphiaRecordsByNames

### Parameters
#### Query Parameters
- **scientificnames** (array of strings) - Required - List of scientific names.

```

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

### GET /AphiaRecordByExternalID/{ID}

Source: https://www.marinespecies.org/rest

Get the Aphia Record for a given external identifier.

```APIDOC
## GET /AphiaRecordByExternalID/{ID}

### Description
Get the Aphia Record for a given external identifier.

### Method
GET

### Endpoint
/AphiaRecordByExternalID/{ID}

### Parameters
#### Path Parameters
- **ID** (string) - Required - The external identifier.

```

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

### GET /AphiaClassificationByAphiaID/{ID}

Source: https://www.marinespecies.org/rest

Get the complete classification for one taxon. This also includes any sub or super ranks.

```APIDOC
## GET /AphiaClassificationByAphiaID/{ID}

### Description
Get the complete classification for one taxon. This also includes any sub or super ranks.

### Method
GET

### Endpoint
/AphiaClassificationByAphiaID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The AphiaID of the taxon.

```

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

### GET /AphiaNameByAphiaID/{ID}

Source: https://www.marinespecies.org/rest/api-docs/openapi.yaml

Retrieves the scientific name associated with a given AphiaID.

```APIDOC
## GET /AphiaNameByAphiaID/{ID}

### Description
Get the name for a given AphiaID.

### Method
GET

### Endpoint
/AphiaNameByAphiaID/{ID}

### Parameters
#### Path Parameters
- **ID** (integer) - Required - The AphiaID to search for

### Response
#### Success Response (200)
- Returns a string (the name).

#### Response Example
200: string

#### Error Responses
- **204** - Nothing found
- **400** - Bad or missing properties (BadRequestError)
```

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

### GET /AphiaRecordsByNames

Source: https://www.marinespecies.org/rest/api-docs/openapi.yaml

This endpoint allows matching multiple scientific names to AphiaRecords in a single call. It supports optional filters for fuzzy matching, marine taxa, and extant taxa.

```APIDOC
## GET /AphiaRecordsByNames

### Description
For each given scientific name, try to find one or more AphiaRecords. This allows you to match multiple names in one call. Limited to 500 names at once for performance reasons.

### Method
GET

### Endpoint
/AphiaRecordsByNames

### Parameters
#### Query Parameters
- **scientificnames[]** (array of string) - Required - Names to search for
- **like** (boolean) - Optional - Add a '%'-sign after the ScientificName (SQL LIKE function). Default=false
- **marine_only** (boolean) - Optional - Limit to marine taxa. Default=true
- **extant_only** (boolean) - Optional - Limit to extant taxa. Default=true

### Response
#### Success Response (200)
- **AphiaRecordsArray** (array) - Successful operation

#### Response Example
{
  "AphiaRecordsArray": []
}

#### Error Response (204)
Nothing found

#### Error Response (400)
Bad or missing properties
```

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

### GET /AphiaRecordsByMatchNames?type=scientificnames

Source: https://www.marinespecies.org/rest/api-docs/openapi.yaml

This endpoint allows users to match scientific names against the WoRMS database and retrieve AphiaRecords for the matched taxa. It supports filtering by taxonomic rank, limiting the number of matches, excluding specific AphiaIDs, and optionally including vernacular names in the search.

```APIDOC
## GET /AphiaRecordsByMatchNames?type=scientificnames

### Description
This endpoint allows users to match scientific names against the WoRMS database and retrieve AphiaRecords for the matched taxa. It supports filtering by taxonomic rank, limiting the number of matches, excluding specific AphiaIDs, and optionally including vernacular names in the search.

### Method
GET

### Endpoint
/AphiaRecordsByMatchNames?type=scientificnames

### Parameters
#### Query Parameters
- **rank_max** (integer) - Optional - The maximum rank of the returned suggestion. Default: 280
- **max_matches** (integer) - Optional - The maximum number of suggestion to return. Default: 20, Max: 50
- **excluded_ids[]** (array of integer) - Optional - AphiaID's to exclude from the resultset
- **combine_vernaculars** (boolean) - Optional - When true the name can also match vernaculars. Default: false
- **marine_only** (boolean) - Optional - Defines if we search for marine taxa only. Default: true
- **fossil_id** (integer) - Optional - Determines the search behavior for fossil taxa (same as for normal search). Default: 0
- **languages[]** (array of string) - Optional - List of ISO 639-3 language codes to filter search results. Example: 'eng', 'nld', 'fra', 'deu'

### Response
#### Success Response (200)
- Successful operation

#### Success Response (204)
- Nothing found

#### Error Response (400)
- Bad or missing properties
- Content: application/json, application/xml
- Schema: BadRequestError
```

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

### GET /AphiaRecordsByMatchNames

Source: https://www.marinespecies.org/rest/api-docs/openapi.yaml

Matches multiple scientific names against the World Register of Marine Species (WoRMS) using the TAXAMATCH fuzzy matching algorithm. Returns AphiaRecords for each matched name.

```APIDOC
## GET /AphiaRecordsByMatchNames

### Description
For each given scientific name (may include authority), try to find one or more AphiaRecords, using the TAXAMATCH fuzzy matching algorithm by Tony Rees. This allows you to (fuzzy) match multiple names in one call. Limited to 50 names at once for performance reasons.

### Method
GET

### Endpoint
/AphiaRecordsByMatchNames

### Parameters
#### Query Parameters
- **scientificnames[]** (array of string) - Required - Names to search for
- **authorships[]** (array of string) - Optional - The authorities of the given names
- **marine_only** (boolean) - Optional - Limit to marine taxa (default: true)
- **extant_only** (boolean) - Optional - Limit to extant taxa (default: true)
- **match_authority** (boolean) - Optional - Use the authority in the matching process (default: true)

### Response
#### Success Response (200)
- **AphiaRecordsArray** (array) - Successful operation

#### Response Example
```json
[
  {
    "AphiaID": 0,
    "url": "string",
    "scientificname": "string",
    "authority": "string",
    "taxonrankID": 0,
    "rank": "string",
    "status": "string",
    "unacceptreason": "string",
    "valid_AphiaID": 0,
    "valid_name": "string",
    "valid_authority": "string",
    "kingdom": "string",
    "phylum": "string",
    "class": "string",
    "order": "string",
    "family": "string",
    "genus": "string",
    "subgenus": "string",
    "species": "string",
    "subspecies": "string"
  }
]
```

#### Error Responses
- **204** - Nothing found
- **400** - Bad or missing properties
```

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

### GET /AphiaRecordsByDate

Source: https://www.marinespecies.org/rest

Lists all AphiaRecords (taxa) that have their last edit action (modified or added) during the specified period.

```APIDOC
## GET /AphiaRecordsByDate

### Description
Lists all AphiaRecords (taxa) that have their last edit action (modified or added) during the specified period.

### Method
GET

### Endpoint
/AphiaRecordsByDate

### Parameters
#### Query Parameters
- **startdate** (string) - Required - Start date of the period.
- **enddate** (string) - Required - End date of the period.

```
Tokens:
Raw