{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/comnames","auth":"required","examples":{"codes":[{"code":"curl \"https://fishbase.ropensci.org/comnames?limit=1\" |  jq .","language":"shell"},{"name":null,"language":"r","code":"library(\"rfishbase\")\ncommon_names(species_list = \"Bolbometopon muricatum\")"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"count\": 319060,\n  \"returned\": 1,\n  \"data\": [\n    {\n      \"autoctr\": 236404,\n      \"ComName\": \" ???????\",\n      \"Transliteration\": \"Varimeen\",\n      \"StockCode\": 135,\n      \"SpecCode\": 121,\n      \"C_Code\": \"356\",\n      \"Language\": \"Telugu\",\n      \"Script\": \"Telugu\",\n...","name":""},{"code":"# A tibble: 64 x 6\n            ComName SpecCode C_Code         Language        Genus   Species\n              <chr>    <int>  <chr>            <chr>        <chr>     <chr>\n 1        Aliyakyak     5537    608          Visayan Bolbometopon muricatum\n 2            Angke     5537    360 Bahasa Indonesia Bolbometopon muricatum\n 3            Angke     5537    360             Bajo Bolbometopon muricatum\n 4            Angke     5537    360            Malay Bolbometopon muricatum\n 5            Angol     5537    608            Bikol Bolbometopon muricatum\n 6            Bayan     5537    458            Malay Bolbometopon muricatum\n 7    Bayan bonggol     5537    458            Malay Bolbometopon muricatum\n 8         Berdebed     5537    585          Palauan Bolbometopon muricatum\n 9            Boila     5537    090             Gela Bolbometopon muricatum\n10 Bulepapegøjefisk     5537    208           Danish Bolbometopon muricatum\n# ... with 54 more rows","language":"r"}]},"settings":"","params":[{"name":"limit","type":"int","default":"10","desc":"number of records to return","required":false,"in":"query","ref":"","_id":"5a0e4a7cc01242001cac3e74"},{"name":"offset","type":"int","default":"0","desc":"record number to start at","required":false,"in":"query","ref":"","_id":"5a0e4a7cc01242001cac3e73"},{"name":"fields","type":"string","default":"","desc":"Comma-separated string of fields to return","required":false,"in":"query","ref":"","_id":"5a0e4a7cc01242001cac3e72"},{"name":"Accept","type":"string","default":"application/vnd.ropensci.v8+json","desc":"Version accept header","required":false,"in":"header","ref":"","_id":"5a1cdcc167d310001245b37d"}],"method":"get"},"next":{"description":"","pages":[]},"title":"comnames","type":"endpoint","slug":"comnames","excerpt":"","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Additional Query Parameters\",\n  \"body\": \"In addition to the query parameters listed (limit, offset, fields) you should be able to query on any of the keys in the response body.\"\n}\n[/block]","updates":[],"order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a0e3156ff22d5001e958e24","project":"5508a8940f146f3500b031c9","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5508a8950f146f3500b031cd","5a0e2e283bb0d9001c09e3e1","5a0e2f9844969800124f4d3a","5a0e2fdcc96bc7001288e17d"],"_id":"5508a8950f146f3500b031cc","__v":4,"createdAt":"2015-03-17T22:20:05.001Z","releaseDate":"2015-03-17T22:20:05.001Z","project":"5508a8940f146f3500b031c9"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Routes","slug":"heartbeat","order":1,"from_sync":false,"reference":false,"_id":"5a0e2fdcc96bc7001288e17d","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","createdAt":"2017-11-17T00:39:56.122Z","__v":0},"user":"5508a87b99a1832100bf9569","createdAt":"2017-11-17T00:46:14.360Z","githubsync":"","__v":5,"parentDoc":null}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

limit:
integer10
number of records to return
offset:
integer0
record number to start at
fields:
string
Comma-separated string of fields to return

Headers

Accept:
stringapplication/vnd.ropensci.v8+json
Version accept header

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Additional Query Parameters", "body": "In addition to the query parameters listed (limit, offset, fields) you should be able to query on any of the keys in the response body." } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}