Lading
Feedback

Please fill out the form below, and we will get back to you as soon as possible.

Description of the issue

  • 繁體中文
  • English
0

Latest 10 notifications

See all

  • No notifications yet.

>

API Documentation

API Documentation

TBIA API - V1

Description of TBIA API

Occurrence API

Resource URL: /api/v1/occurrence
The service will perform partial data blurred. Access to the restricted API for non-blurred data is currently available only to TBIA partner organizations.

Query Parameters

Parameter Type Description Example
id string Get record by TBIA ID /api/v1/occurrence?id=6540d35818aad00028ecda95
occurrenceID string Get record by occurrenceID /api/v1/occurrence?occurrenceID=TAIF:PLANT:8540:1:1:186874
catalogNumber string Get record by catalogNumber /api/v1/occurrence?catalogNumber=186874
recordNumber string Get record by recordNumber /api/v1/occurrence?recordNumber=218114
name string List records by scientific name / common name / synonym / misapplied name /api/v1/occurrence?name=小白鷺
taxonID string List records by TaiCOL taxon ID /api/v1/occurrence?taxonID=t0052516
higherTaxon string List records by higher taxon (using TaiCOL taxon ID) /api/v1/occurrence?higherTaxon=t0002476
bioGroup string Retrieve occurrence records for the specified biological group; composite queries are supported. Please refer to the Controlled Vocabulary List. /api/v1/occurrence?bioGroup=鳥類
taxonRank string Retrieve occurrence records for the specified taxonomic rank. Please refer to the Controlled Vocabulary List. /api/v1/occurrence?taxonRank=infraspecies
isCollection boolean List records by if the record is a natural history collection. Yes = true, No = false. /api/v1/occurrence?isCollection=true
isNative boolean List records by if the record is a native species. Yes = true, No = false. /api/v1/occurrence?isNative=true
isProtected boolean List records by if the record is a protected species. Yes = true, No = false. /api/v1/occurrence?isProtected=true
hasMedia boolean List records by if the record has associated media. No = false, Image = image, Video = video, Audio = audio, /api/v1/occurrence?hasMedia=image
rightsHolder string Retrieve occurrence records from the specified source database / collection institution; composite queries are supported. Please refer to the Controlled Vocabulary List. /api/v1/occurrence?rightsHolder=台灣生物多樣性網絡 TBN&rightsHolder=濕地環境資料庫
recordedBy string List records by recorder /api/v1/occurrence?recordedBy=志工小組
resourceContacts string List records by resource contacts /api/v1/occurrence?resourceContacts=台灣兩棲類保育志工團隊
tbiaDatasetID string Retrieve specific occurrence records using this site's dataset ID; composite queries are supported. /api/v1/occurrence?tbiaDatasetID=d674d7e0ec3bd2c006cefb438
datasetName string Retrieve occurrence records of the specified dataset; composite queries are supported. /api/v1/occurrence?datasetName=100年高雄都會公園環境長期監測研究計畫－生物（動植物）
basisOfRecord string List records by basis of record /api/v1/occurrence?basisOfRecord=HumanObservation
eventDate date Event date. Format: yyyy-mm-dd. Range queries are supported. /api/v1/occurrence?eventDate=2021-10-21
preservation string List records by preservation /api/v1/occurrence?preservation=針插標本
typeStatus string List records by type status /api/v1/occurrence?typeStatus=模式
organismQuantity number List records by organism quantity /api/v1/occurrence?organismQuantity=100
locality string Retrieve occurrence records for the specified locality; composite queries are supported. /api/v1/occurrence?locality=高雄市
county string List records by a county /api/v1/occurrence?county=高雄市
municipality string List records by a municipality /api/v1/occurrence?municipality=楠梓區
boundedBy string Retrieve grid data by a bounding box. Specified by={max longitude},{max latitude},{min longitude},{min latitude}. /api/v1/occurrence?boundedBy=122,24,121,23
polygon string List records by a polygon. Only WKT format is supported. /api/v1/occurrence?polygon=POLYGON ((120.761719 23.755182, 120.772705 23.543845, 121.135254 23.5237, 121.135254 23.755182, 120.761719 23.755182))
circle string List records by a circle. Specified by={longitude of centre},{latitude of centre},{radius in KM}. /api/v1/occurrence?circle=122.51,24.9,10
apikey string Restricted API Key /api/v1/occurrence?apikey={yourAPIkey}
created date Record creation time. Format: yyyy-mm-dd. Range queries are supported. /api/v1/occurrence?created=2023-05-09
modified date Record modification time. Format: yyyy-mm-dd. Range queries are supported. /api/v1/occurrence?modified=2023-05-09

Return Data

Parameter Name Type Note
id TBIA ID string
created Created Date (TBIA Portal) date
modified Modified Date (TBIA Portal) date
standardDate Standardized Event Date date
standardLatitude Standardized Latitude float
standardLongitude Standardized Non-blurred Longitude float
standardRawLatitude Standardized Non-blurred Latitude float Obtained by restricted API
standardRawLongitude Standardized Non-blurred Longitude float Obtained by restricted API
standardOrganismQuantity Standardized Organization Quantity float
associatedMedia Associated Media string Values are separated by semicolon
basisOfRecord Basis of Record string Please refer to the Controlled Vocabulary List.
catalogNumber Catalog Number string
coordinatePrecision Coordinate Precision string Please refer to the sixth point in the TBIA released document on the 生物多樣性敏感資料開放作業原則文件 for a detailed explanation.
coordinateUncertaintyInMeters Coordinate Uncertainty in Meters string
dataGeneralizations Data Generalizations boolean
datasetName Dataset Name string
tbiaDatasetID TBIA Dataset ID string
sourceDatasetID Source Dataset ID string
gbifDatasetID GBIF Dataset ID string
eventDate Event Date string
license License string
locality Locality string
mediaLicense Media License string
occurrenceID occurrenceID string
organismQuantity Organism Quantity string
organismQuantityType Organism Quantity Type string
originalScientificName Original Taxon string
preservation Preservation string
recordedBy Recorded By string
recordNumber Record Number string
references References string
resourceContacts Resource Contacts string
rightsHolder Rights Holder string
sensitiveCategory Sensitive Category string
sourceCreated Created Date (Rights Holder) date
sourceModified Modified Date (Rights Holder) date
sourceScientificName Source Scientific Name string
sourceVernacularName Source Vernacular Name string
typeStatus Type Status string
verbatimCoordinateSystem Verbatim Coordinate System string
verbatimLatitude Latitude string
verbatimLongitude Longitude string
verbatimRawLatitude Non-blurred Latitude string Obtained by restricted API
verbatimRawLongitude Non-blurred Longitude string Obtained by restricted API
county County string
municipality Township / Town / City / District string
rawCounty Non-blurred County string Obtained by restricted API
rawMunicipality Non-blurred Township / Town / City / District string Obtained by restricted API
verbatimSRS Verbatim SRS string
scientificNameID Scientific Name ID (from Rights Holder) string Scientific Name ID provieded by original data. Could be TaiCOL namecode.
taxonID Taxon ID string TaiCOL Taxon ID
match_higher_taxon If Matches Higher Taxon boolean If the taxon ID of the record is matched to its higher taxon. Yes = true, No = false.
scientificName Scientific Name string
name_author Name Author string
bioGroup Biological Group string Please refer to the Controlled Vocabulary List.
taxonRank Taxon Rank string Please refer to the Controlled Vocabulary List.
common_name_c Chinese Common Name string
alternative_name_c Chinese Alternative Name string
synonyms Synonyms string
misapplied Misapplied Name string
kingdom Kingdom string
kingdom_c Kingdom in Chinese string
phylum Phylum string
phylum_c Phylum in Chinese string
class Class string
class_c Class in Chinese string
order Order string
order_c Order in Chinese string
family Family string
family_c Family in Chinese string
genus Genus string
genus_c Genus in Chinese string

Dataset API

Resource URL: /api/v1/dataset

Query Parameters

Parameter Type Description Example
tbiaDatasetID string Get dataset by TBIA datasetID /api/v1/dataset?tbiaDatasetID=d674d7dc6c3bd2c006cefad10
sourceDatasetID string Get dataset by sourceDatasetID from rights holder /api/v1/dataset?sourceDatasetID=ac869aba-ac34-4416-9eda-075258fef27a
gbifDatasetID string Get dataset by GBIF datasetID /api/v1/dataset?gbifDatasetID=275319e1-f91c-406f-b239-62cb9d4185cb
rightsHolder string Retrieve datasets from the specified source database / collection institution; composite queries are supported. Please refer to the Controlled Vocabulary List. /api/v1/dataset?rightsHolder=台灣生物多樣性網絡 TBN&rightsHolder=濕地環境資料庫
datasetName string List dataset by dataset name, supporting partial matching /api/v1/dataset?datasetName=eBird
datasetTaxonGroup string Retrieve datasets that include the specified biological group; composite queries are supported. Please refer to the Controlled Vocabulary List. /api/v1/dataset?datasetTaxonGroup=鳥類
created date Dataset creation time. Format: yyyy-mm-dd. Range queries are supported. /api/v1/dataset?created=2023-05-09
modified date Dataset modification time. Format: yyyy-mm-dd. Range queries are supported. /api/v1/dataset?modified=2023-05-09

Return Data

Parameter Name Type Note
datasetName Dataset Name string
rightsHolder Rights Holder string Please refer to the Controlled Vocabulary List.
tbiaDatasetID TBIA Dataset ID string
sourceDatasetID Source Dataset ID string
gbifDatasetID GBIF Dataset ID string
resourceContacts Resource Contacts string
occurrenceCount Number of Records Included in the Dataset integer
datasetDateStart Dataset Start Date date
datasetDateEnd Dataset End Date date
datasetURL Dataset URL string
datasetPublisher Dataset Publisher string
datasetLicense Dataset License string
datasetTaxonGroup Biological Groups Included in the Dataset string Please refer to the Controlled Vocabulary List.
created Dataset Created Date (TBIA Portal) date
modified Dataset Modified Date (TBIA Portal) date

Map API

Resource URL: /api/v1/map

Query Parameters

Parameter Type Description Example
boundedByRequired string Retrieve grid data by a bounding box. Specified by={max longitude},{max latitude},{min longitude},{min latitude}. /api/v1/map?boundedBy=122,23,121,22&grid=1
gridRequired integer Retrieve grid data in specified grid size, providing 1, 5, 10, and 100 km grids.
Default is 1. 		/api/v1/map?boundedBy=122,23,121,22&grid=1
taxonID string Retrieve grid data by TaiCOL taxon ID. /api/v1/map?boundedBy=122,23,121,22&grid=1&taxonID=t0052516
bioGroup string Retrieve grid data that include the specified biological group; composite queries are supported. Please refer to the Controlled Vocabulary List. /api/v1/map?boundedBy=122,23,121,22&grid=1&bioGroup=鳥類
year integer Retrieve grid data for the specified year. Format: yyyy. Range queries are supported. /api/v1/map?boundedBy=122,23,121,22&grid=1&year=2024

Due to performance considerations, the bounding box range must be used in conjunction with the grid size. If you need to retrieve data in a larger geographical area, please split it into smaller sections and retrieve them separately.

Grid size Available latitude and longitude range Example
1 km 1 degree /api/v1/map?boundedBy=122,23,121,22&grid=1
5 km 10 degrees /api/v1/map?boundedBy=125,25,115,15&grid=5
10 km 20 degrees /api/v1/map?boundedBy=122,23,102,3&grid=10
100 km 40 degrees /api/v1/map?boundedBy=120,25,80,-15&grid=100

Return Data

Returns a 1, 5, 10, or 100 km gridded polygon in GeoJSON format. The retrieved GeoJSON can be directly overlaid on the map, with each feature representing a grid and containing attributes:

  • Number of records in a grid counts
  • Grid size current_grid_level
  • Grid number current_grid
If you want to create a map similar to TBIA portal, you can refer to the following number of records and corresponding color codes:
Number of Records Color Code
1 - 10 #ffffcc
10 - 100 #ffeda0
100 - 1000 #fed976
1000 - 5000 #feb24c
5000 - 10000 #fd8d3c
10000 - 50000 #fc4e2a
50000 - 100000 #e31a1c
100000+ #bd0026

Common Operations

Composite Query

Each query parameter supports intersection queries, and some parameters also support union queries. When querying multiple values using the same parameter, a union will be applied; when querying different parameters at the same time, an intersection will be applied.

Example 1: Different parameters (Intersection / AND)
/api/v1/occurrence?boundedBy=122,24,121,23&rightsHolder=GBIF

Example 2: Multiple values for the same parameter (Union / OR)
/api/v1/occurrence?bioGroup=鳥類&bioGroup=哺乳類

Range Query

Some date or year parameters support range queries using a half-width comma to separate the start and end values.

Example 1: Date Range
/api/v1/occurrence?eventDate=2021-10-21,2021-10-25

Example 2: Year Range
/api/v1/map?boundedBy=122,23,121,22&grid=1&year=2020,2025

Pagination

Parameter Description Example
limit Controls the number of results in the page. By default limit is 20. The limit can be a maximum of 1000 for a single request. /api/v1/occurrence?limit=1000

Due to performance considerations, each request can return a maximum of 1000 records. You can retrieve the URL of the next page using the next parameter returned, and recursively fetch all the data.

Status

Code Description
200 OK
400 Bad Request
404 Not Found
500 Internal Server Error

Response

{
							"status": {
								"code": Return status code,
								"message": Status
							},
							"meta": {
								"total": Total count matching query criteria,
								"limit": Number of records per page,
							},
							"links": {
								"self": Current page URL,
								"next": Next page URL
							},	
							"data":[Result array]
						}

Lists of Controlled Vocabulary

The following parameters use a controlled vocabulary; please use the specific values listed below for queries.

Basis of Record

  • HumanObservation
  • MachineObservation
  • PreservedSpecimen
  • MaterialSample
  • LivingSpecimen
  • FossilSpecimen
  • MaterialCitation
  • MaterialEntity
  • Taxon
  • Occurrence
  • Event

Taxon Rank

  • kingdom
  • phylum
  • class
  • order
  • family
  • genus
  • species
  • infraspecies

Rights Holder

  • GBIF
  • 中央研究院生物多樣性中心動物標本館
  • 中央研究院生物多樣性中心植物標本資料庫
  • 台灣生物多樣性網絡 TBN
  • 國立臺灣博物館典藏
  • 林業試驗所昆蟲標本館
  • 林業試驗所植物標本資料庫
  • 河川環境資料庫
  • 濕地環境資料庫
  • 生態調查資料庫系統
  • 臺灣國家公園生物多樣性資料庫
  • 臺灣生物多樣性資訊機構 TaiBIF
  • 海洋保育資料倉儲系統
  • 科博典藏 (NMNS Collection)
  • 臺灣魚類資料庫
  • 國家海洋資料庫及共享平台
  • 集水區友善環境生態資料庫
  • 中油生態地圖
  • 作物種原資訊系統
  • 國立海洋生物博物館生物典藏管理系統
  • 愛自然-臺灣(iNaturalist Taiwan)

Biological Group

  • Birds
  • Reptiles
  • Mammals
  • Fishes
  • Amphibians
  • Beetles
  • Moths
  • Butterflies
  • Dragonflies
  • Other Insects
  • Spiders
  • Snails & Shells
  • Crustaceans
  • Gymnosperms
  • Angiosperms
  • Ferns

Search Reminder

  • To search for all insects: Please use a composite query for "Beetles, Moths, Butterflies, Dragonflies, and Other Insects".
  • To search for vascular plants: Please use a composite query for "Gymnosperms, Angiosperms, and Ferns".

Terms of Use

The API provided by this website adopts the same terms of use as this website.

Update History

  • 2026-05-15 ｜ Changes to bioGroup: The original "Insects" category has been split into: Beetles, Moths, Butterflies, Dragonflies, and Other Insects. The "Vascular Plants" category has been subdivided into: Gymnosperms, Angiosperms, and Ferns. New Categories Added: Snails & Shell, Crustaceans.

    2026-05-15 ｜ The original field imagePresence has been renamed to hasMedia. The supported parameters are as follows: false, image, video, audio

    2025-02-05 ｜ Add Map API

    2024-12-13 ｜ Add Dataset API

  • 2024-06-27 ｜ Modified the pagination parameter.

  • 2023-12-12 ｜ V1 release note

目錄

Taiwan Biodiversity Information Alliance
Email：tbianoti@gmail.com

Funders

Funders Funders
Copyright © TBIA Taiwan Biodiversity Information Alliance