登入
Email：tbianoti@gmail.com
贊助單位
請填寫下列表格，我們將會儘快回覆
臺灣生物多樣性資訊聯盟 (Taiwan Biodiversity Information Alliance, TBIA) API使用說明，點選標題可錨點至該項：
| 參數 | 名稱 | 型值 | 備註 |
| id | 入口網ID | string | |
| created | 入口網資料建立時間 | date | |
| modified | 入口網資料修改時間 | date | |
| standardDate | 標準化日期 | date | |
| standardLatitude | 標準化緯度 | float | |
| standardLongitude | 標準化經度 | float | |
| standardRawLatitude | 標準化未模糊化緯度 | float | 需透過限制型API取得 |
| standardRawLongitude | 標準化未模糊化經度 | float | 需透過限制型API取得 |
| standardOrganismQuantity | 標準化數量 | float | |
| associatedMedia | 影像URL | string | 多值以分號;分隔 |
| basisOfRecord | 紀錄類型 | string | |
| catalogNumber | 館藏號 | string | |
| coordinatePrecision | 座標模糊化程度 | string | 請參考生物多樣性敏感資料開放作業原則文件中的逐條說明第六點 |
| coordinateUncertaintyInMeters | 座標誤差（公尺） | string | |
| dataGeneralizations | 座標是否有模糊化 | boolean | |
| datasetName | 資料集名稱 | string | |
| tbiaDatasetID | 入口網資料集ID | string | |
| sourceDatasetID | 來源資料庫資料集ID | string | |
| gbifDatasetID | GBIF資料集ID | string | |
| eventDate | 紀錄日期 / 採集日期 | string | |
| license | 授權狀況 | string | |
| locality | 出現地 / 採集地 | string | |
| mediaLicense | 影像授權 | string | |
| occurrenceID | occurrenceID | string | |
| organismQuantity | 數量 | string | |
| organismQuantityType | 數量單位 | string | |
| originalScientificName | 原始紀錄物種 | string | |
| preservation | 保存方式 | string | |
| recordedBy | 記錄者 / 採集者 | string | |
| recordNumber | 採集號 | string | |
| references | 原資料庫網頁URL | string | |
| resourceContacts | 資料集聯絡人 | string | |
| rightsHolder | 來源資料庫 / 典藏單位 | string | |
| sensitiveCategory | 敏感層級 | string | |
| sourceCreated | 來源資料庫資料建立時間 | date | |
| sourceModified | 來源資料庫資料修改時間 | date | |
| sourceScientificName | 來源資料庫使用學名 | string | |
| sourceVernacularName | 來源資料庫使用中文名 | string | |
| typeStatus | 標本類型 | string | |
| verbatimCoordinateSystem | 座標系統 | string | |
| verbatimLatitude | 緯度 | string | |
| verbatimLongitude | 經度 | string | |
| verbatimRawLatitude | 未模糊化緯度 | string | 需透過限制型API取得 |
| verbatimRawLongitude | 未模糊化經度 | string | 需透過限制型API取得 |
| county | 縣市 | string | |
| municipality | 鄉鎮市區 | string | |
| rawCounty | 未模糊化縣市 | string | 需透過限制型API取得 |
| rawMunicipality | 未模糊化鄉鎮市區 | string | 需透過限制型API取得 |
| verbatimSRS | 空間參考系統 | string | |
| scientificNameID | 物種代碼 | string | 原始資料提供之物種代碼，可能為舊TaiCOL namecode |
| taxonID | 物種編號 | string | 新版TaiCOL物種編號 |
| match_higher_taxon | 是否對應到上階層 | boolean | 若無法對到taxonID，則在taxonID欄位給予可以對到的上階層ID，此時match_higer_taxon標示true，反之為false |
| scientificName | 學名 | string | |
| name_author | 學名作者 | string | |
| bioGroup | 物種類群 | string | |
| taxonRank | 鑑定層級 | string | |
| common_name_c | 中文名 | string | |
| alternative_name_c | 中文別名 | string | |
| synonyms | 同物異名 | string | |
| misapplied | 誤用名 | string | |
| kingdom | 界 | string | |
| kingdom_c | 界中文名 | string | |
| phylum | 門 | string | |
| phylum_c | 門中文名 | string | |
| class | 綱 | string | |
| class_c | 綱中文名 | string | |
| order | 目 | string | |
| order_c | 目中文名 | string | |
| family | 科 | string | |
| family_c | 科中文名 | string | |
| genus | 屬 | string | |
| genus_c | 屬中文名 | string |
| 參數 | 型值 | 說明 | 範例網址 |
| tbiaDatasetID | string | 使用本網站之資料集ID取得指定的資料集 | /api/v1/dataset?tbiaDatasetID=d674d7dc6c3bd2c006cefad10 |
| sourceDatasetID | string | 使用來源資料庫 / 典藏單位之資料集ID取得指定的資料集 | /api/v1/dataset?sourceDatasetID=ac869aba-ac34-4416-9eda-075258fef27a |
| gbifDatasetID | string | 以GBIF的資料集ID取得指定的資料集 | /api/v1/dataset?gbifDatasetID=275319e1-f91c-406f-b239-62cb9d4185cb |
| rightsHolder | string | 取得指定來源資料庫 / 典藏單位的資料集 | /api/v1/dataset?rightsHolder=台灣生物多樣性網絡 TBN&rightsHolder=濕地環境資料庫 |
| datasetName | string | 以資料集名稱查詢，支援部分查詢 | /api/v1/dataset?datasetName=eBird |
| datasetTaxonGroup | string | 取得含括指定物種類群的資料集 | /api/v1/dataset?datasetTaxonGroup=鳥類 |
| created | date | 資料集建立時間，日期格式：yyyy-mm-dd。支援區間查詢 | /api/v1/dataset?created=2023-05-09 |
| modified | date | 資料集更新時間，日期格式：yyyy-mm-dd。支援區間查詢 | /api/v1/dataset?modified=2023-05-09 |
| 參數 | 名稱 | 型值 | 備註 |
| datasetName | 資料集名稱 | string | |
| rightsHolder | 來源資料庫 / 典藏單位 | string | |
| tbiaDatasetID | 入口網資料集ID | string | |
| sourceDatasetID | 來源資料庫資料集ID | string | |
| gbifDatasetID | GBIF資料集ID | string | |
| resourceContacts | 資料集聯絡人 | string | |
| occurrenceCount | 含括資料筆數 | integer | |
| datasetDateStart | 涵蓋日期起始 | date | |
| datasetDateEnd | 涵蓋日期結束 | date | |
| datasetURL | 資料集URL | string | |
| datasetPublisher | 資料集發布者 | string | |
| datasetLicense | 資料集授權狀況 | string | |
| datasetTaxonGroup | 含括物種類群 | string | |
| created | 入口網資料集建立時間 | date | |
| modified | 入口網資料集修改時間 | date |
| 參數 | 型值 | 說明 | 範例網址 |
| boundedBy | string |
取得指定四邊形座標範圍內物種出現紀錄網格資料，輸入值={最大經度},{最大緯度},{最小經度},{最小緯度}
*必填 |
/api/v1/map?boundedBy=122,23,121,22&grid=1 |
| grid | integer |
取得指定網格大小，提供1,5,10,100公里網格
*必填，預設為1 |
/api/v1/map?boundedBy=122,23,121,22&grid=1 |
| taxonID | string | 取得指定TaiCOL物種編號的物種網格資料 | /api/v1/map?boundedBy=122,23,121,22&grid=1&taxonID=t0052516 |
| bioGroup | string | 取得含括指定物種類群的網格資料 | /api/v1/map?boundedBy=122,23,121,22&grid=1&bioGroup=鳥類 |
| year | integer | 取得指定資料年份的網格資料，年份格式：yyyy。支援區間查詢 | /api/v1/map?boundedBy=122,23,121,22&grid=1&year=2024 |
| 資料筆數 | 色碼 |
| 1 - 10 | #ffffcc |
| 10 - 100 | #ffeda0 |
| 100 - 1000 | #fed976 |
| 1000 - 5000 | #feb24c |
| 5000 - 10000 | #fd8d3c |
| 10000 - 50000 | #fc4e2a |
| 50000 - 100000 | #e31a1c |
| 100000+ | #bd0026 |
| 參數 | 說明 | 範例網址 |
| limit | 限制回傳筆數。預設20筆，上限1000 | /api/v1/occurrence?limit=1000 |
| 代碼(code) | 說明 |
| 200 | 輸入的請求成功 |
| 400 | 輸入的請求無效 |
| 404 | 網址錯誤或資源不存在 |
| 500 | 後端伺服器錯誤 |
{
"status": {
"code": 回傳狀態代碼,
"message": 回傳狀態說明
},
"meta": {
"total": 符合查詢條件全部筆數,
"limit": 每頁回傳筆數,
},
"links": {
"self": 本頁網址,
"next": 下一分頁網址
},
"data":[結果陣列]
}
