台灣生物多樣性網絡

簡介

本文件由農業部生物多樣性研究所編製，描述所屬台灣生物多樣性網絡（Taiwan Biodiversity Network，TBN）之物種（taxon）開放API規格。

服務類型

本API提供查詢TBN物種之服務。

查詢參數

參數型態

UUID：字串，RFC 4122，需含斷字符號共36個字元
文字
列舉

參數名	參數中文名	型態	說明	範例網址
UUID	物種UUID	UUID	TBN物種UUID	https://www.tbn.org.tw/api/v25/taxon?uuid=0f4a4cbf-de63-43e0-bcaa-381c161c63e6
name	物種名	文字	支援部分查詢	https://www.tbn.org.tw/api/v25/taxon?name=攀蜥
taxonGroup	類群	列舉	taxonGroup代碼表	https://www.tbn.org.tw/api/v25/taxon?taxonGroup=哺乳類 https://www.tbn.org.tw/api/v25/taxon?taxonGroup=mammals
endemism	台灣特有	文字	「台灣特有」or「taiwan」	https://www.tbn.org.tw/api/v25/taxon?endemism=台灣特有 https://www.tbn.org.tw/api/v25/taxon?endemism=taiwan
nativeness	原生性	列舉	外來 Non-native, 外來栽培 Cultivated (non-native), 外來歸化 Naturalized (non-native), 原生 Native, 境外 Overseas nativeness代碼表	https://www.tbn.org.tw/api/v25/taxon?nativeness=外來 Non-native https://www.tbn.org.tw/api/v25/taxon?nativeness=v
taiCoLNameCode	taiCOL編碼	文字	TaiCOL臺灣物種名錄編碼	https://www.tbn.org.tw/api/v25/taxon?taiCoLNameCode=416107
protectedStatusTW	保育狀態	列舉	瀕臨絕種保育類野生動物, 珍貴稀有保育類野生動物, 其他應予保育之野生動物, 文化資產保存法：珍貴稀有植物 protectedStatusTW代碼表	https://www.tbn.org.tw/api/v25/taxon?protectedStatusTW=瀕臨絕種保育類野生動物 https://www.tbn.org.tw/api/v25/taxon?protectedStatusTW=I
categoryRedlistTW	國內紅皮書	列舉	未評估（NE, Not Evaluated）, 不適用, 資料缺乏（DD, Data Deficient）, 暫無危機（LC, Least Concern）, 接近受脅（NT, Near Threatened）, 易危（VU, Vulnerable）, 瀕危（EN, Endangered）, 極危（CR, Critically Endangered）, 區域滅絕（RE, Regionally Extinct）, 野外絕滅（EW, Extinct in the Wild）, 絕滅（EX, Extinct） categoryRedlistTW代碼表	https://www.tbn.org.tw/api/v25/taxon?categoryRedlistTW=易危（VU, Vulnerable） https://www.tbn.org.tw/api/v25/taxon?categoryRedlistTW=VU
categoryIUCN	國際紅皮書	列舉	未評估（NE, Not Evaluated）, 資料缺乏（DD, Data Deficient）, 暫無危機（LC, Least Concern）, 易危（VU, Vulnerable）, 接近受脅（NT, Near Threatened）, 瀕危（EN, Endangered）, 極危（CR, Critically Endangered）, 野外絕滅（EW, Extinct in the Wild）, 絕滅（EX, Extinct） categoryIUCN代碼表	https://www.tbn.org.tw/api/v25/taxon?categoryIUCN=極危（CR, Critically Endangered） https://www.tbn.org.tw/api/v25/taxon?categoryIUCN=CR
sensitiveCategory	敏感狀態	列舉	[無, 輕度, 重度, 縣市, 座標不開放, 物種不開放]	https://www.tbn.org.tw/api/v25/taxon?sensitiveCategory=重度
withChildren	是否輸出子階層分類群	布林	需搭配其他查詢條件	https://www.tbn.org.tw/api/v25/taxon?uuid=bcdf74e8-60da-49ff-9b8e-ca09b9224035&withChildren=1

taxonGroup代碼表

code	value
birds	鳥類
reptiles	爬行類
mammals	哺乳類
beetles	甲蟲類
fishes	魚類
amphibians	兩棲類
moths	蛾類
butterflies	蝶類
spiders	蜘蛛類
dragonflies	蜻蛉類
snailsshells	蝸牛與貝類
otherinvertebrates	其他無脊椎
otherinsects	其他昆蟲
crustaceans	蝦蟹類
lycophytes	石松類
gymnosperms	裸子植物
angiosperms	被子植物
ferns	蕨類
chromista	原藻類
mosses	苔蘚
fungi	真菌類

nativeness代碼表

code	value
i	原生 Native
v	外來 Non-native
n	外來歸化 Naturalized (non-native)
a	外來栽培 Cultivated (non-native)
o	境外 Overseas

protectedStatusTW代碼表

code	value
I	瀕臨絕種保育類野生動物
II	珍貴稀有保育類野生動物
III	其他應予保育之野生動物
CHPA	文化資產保存法：珍貴稀有植物

categoryRedlistTW代碼表

code	value
EX	滅絕（EX, Extinct）
EW	野外滅絕（EW, Extinct in the Wild）
RE	區域滅絕（RE, Regionally Extinct）
CR	極危（CR, Critically Endangered）
EN	瀕危（EN, Endangered）
VU	易危（VU, Vulnerable）
NT	接近受脅（NT, Near Threatened）
LC	暫無危機（LC, Least Concern）
DD	資料缺乏（DD, Data Deficient）
NA	不適用
NE	未評估（NE, Not Evaluated）

categoryIUCN代碼表

code	value
EX	滅絕（EX, Extinct）
EW	野外滅絕（EW, Extinct in the Wild）
CR	極危（CR, Critically Endangered）
EN	瀕危（EN, Endangered）
VU	易危（VU, Vulnerable）
NT	接近受脅（NT, Near Threatened）
LC	暫無危機（LC, Least Concern）
DD	資料缺乏（DD, Data Deficient）
NE	未評估（NE, Not Evaluated）

複合查詢

各查詢參數均可做聯集查詢。如以下網址查詢"哺乳類"中"台灣特有種"的物種

https://www.tbn.org.tw/api/v25/taxon?taxonGroup=哺乳類&endemism=taiwan

回傳範例：

{
    "meta": {
        status: "SUCCESS",
        total: 54,
        itemsCount: 54,
        generateDate: "2022-03-08T15:20:43+08:00"
    },
    "links": {
        self: "https://www.tbn.org.tw/api/v25/taxon?taxonGroup=%E5%93%BA%E4%B9%B3%E9%A1%9E&endemism=%E5%8F%B0%E7%81%A3%E7%89%B9%E6%9C%89",
        next: ""
    },
    "data": [
        {
            "taxonUUID": "59e4538f-605e-4f8a-954d-6695df1d6fdc",
            "parentUUID": "5ab0f210-087a-4534-a089-963de6dc55e9",
            "taxonName": "短尾鼩 Anourosorex yamashinai",
            "scientificName": "Anourosorex yamashinai",
            "vernacularName": "短尾鼩",
            "simplifiedScientificName": "Anourosorex yamashinai",
            "taxonRank": "種",
            "class": "Mammalia",
            "family": "Soricidae",
            "taxonGroup": "哺乳類",
            "endemism": "台灣特有",
            "nativeness": "原生 Native",
            "protectedStatusTW": null,
            "categoryRedlistTW": "暫無危機（LC, Least Concern）",
            "categoryIUCN": "暫無危機（LC, Least Concern）",
            "sensitiveCategory": null,
            "taiColNameCode": "416053",
            "tfNameCode": null,
            "children": null
        },
        ...
    ]
}

查詢特定參數，加上withChildren，釋出下一階子分類群資料將會填入"children"欄位

https://www.tbn.org.tw/api/v25/taxon?name=麻雀&withChildren=1

回傳範例：

{
    "meta": {
        status: "SUCCESS",
        total: 8,
        itemsCount: 8,
        generateDate: "2022-03-08T15:20:43+08:00"
    },
    "links": {
        self: "https://www.tbn.org.tw/api/v25/taxon?name=%E9%BA%BB%E9%9B%80&withChildren=1",
        next: ""
    },
    "data": [
        {
            "taxonUUID": "1eda1fcc-84c0-4065-a530-71d362fb6b30",
            "parentUUID": "18d524d4-ac32-4db7-b59f-e008efb3b52a",
            "taxonName": "麻雀科 Passeridae"",
            "scientificName": "Passeridae",
            "vernacularName": "麻雀科",
            "simplifiedScientificName": "Passeridae",
            "taxonRank": "科",
            "class": "Aves",
            "family: "Passeridae",
            "taxonGroup": "鳥",
            "endemism": null,
            "nativeness": null,
            "protectedStatusTW": null,
            "categoryRedlistTW": null,
            "categoryIUCN": null,
            "sensitiveCategory": null,
            "taiColNameCode": null,
            "tfNameCode": null,
            "children": [
                {
                     "taxonUUID": "c1975a33-1bd1-4b3b-8e53-a7be6a74852a",
                     "parentUUID": "1eda1fcc-84c0-4065-a530-71d362fb6b30",
                     "taxonName": "麻雀屬 Passer",
                     "scientificName": "Passer",
                     "vernacularName": "麻雀屬",
                     "simplifiedScientificName": "Passer",
                     "taxonRank": "屬",
                     "class": "Aves",
                     "family": "Passeridae",
                     "taxonGroup": "鳥",
                     "endemism": null, 
                     "nativeness": null, 
                     "protectedStatusTW": null, 
                     "categoryRedlistTW": null, 
                     "categoryIUCN": null, 
                     "sensitiveCategory": null, 
                     "taiColNameCode": null, 
                     "tfNameCode": null, 
                     "children": null
               }
            ]
        },
        ...
    ]
}

資料欄位

JSON欄位名

欄位名 (JSON field name) 均為羅馬字英文字母，大小寫不同，範圍為[a-zA-Z]。
欄位名命名採首字小寫駝峰式 (Camel) 命名法。

資料型態與允許值

UUID：字串，RFC 4122，需含斷字符號共36個字元
文字
列舉：為規定值之一
允許多值時，多值以半形分號;分隔
無資料時回傳null

回傳欄位表

API欄位名	中文欄位名	型態	值與說明
taxonUUID	物種UUID	UUID	TBN分類群UUID
parentUUID	上層分類群UUID	UUID	上層分類群taxonUUID
taxonName	物種名	文字	含學名與俗名及HTML格式資訊
scientificName	學名	文字	含學名HTML格式資訊
vernacularName	分類群俗名	文字
simplifiedScientificName	簡學名	文字
taxonRank	分類階層	列舉	taxonRank分類階層表
class	綱名	文字
family	科名	文字
taxonGroup	類群	列舉	[哺乳類,鳥類,爬行類,兩棲類,甲蟲類,魚類,蛾類,蝶類,蜘蛛類,蜻蛉類,蝸牛與貝類,其他無脊椎,其他昆蟲,螃蟹類,石松類,裸子植物,被子植物,蕨類,原藻類,苔蘚,真菌類]
endemism	臺灣特有	列舉	[台灣特有]
nativeness	原生性	列舉	[原生 Native,外來 Non-native,外來歸化 Naturalized (non-native),外來栽培 Cultivated (non-native),境外 Overseas]
protectedStatusTW	保育類等級	列舉	[瀕臨絕種保育類野生動物,珍貴稀有保育類野生動物,其他應予保育之野生動物,文化資產保存法：珍貴稀有植物]
categoryRedlistTW	國內紅皮書	列舉	[未評估（NE, Not Evaluated）,不適用, 資料缺乏（DD, Data Deficient）,暫無危機（LC, Least Concern）,接近受脅（NT, Near Threatened）,易危（VU, Vulnerable）,瀕危（EN, Endangered）,極危（CR, Critically Endangered）,區域滅絕（RE, Regionally Extinct）,野外絕滅（EW, Extinct in the Wild）,絕滅（EX, Extinct）]
categoryIUCN	國際紅皮書	列舉	[未評估（NE, Not Evaluated）,資料缺乏（DD, Data Deficient）,暫無危機（LC, Least Concern）,接近受脅（NT, Near Threatened）,易危（VU, Vulnerable）,瀕危（EN, Endangered）,極危（CR, Critically Endangered）,野外絕滅（EW, Extinct in the Wild）,絕滅（EX, Extinct）]
sensitiveCategory	敏感資料標示	列舉	[無,輕度,重度,縣市,座標不開放,物種不開放]
taiColNameCode	TaiCOL編碼	文字	TaiCOL臺灣物種名錄編碼
tfNameCode	taxonfileCladeID	文字	植物學名編輯系統（TaxonFile）學名代碼（未開放）
children	子分類群	陣列	若指定輸出子階層分類群時，子分類群（限一層）列於此。子階層欄位及本回傳欄位

taxonRank分類階層表

值
總域
域
亞域
總界
界
亞界
總門
門
亞門
總綱
綱
亞綱
總目
目
亞目
總科
科
亞科
屬
亞屬
種
種下階層

Taxon API 2.5

簡介

服務類型

查詢參數

複合查詢

資料欄位