{"_id":"5508a8960f146f3500b031cf","title":"Getting Started","project":"5508a8940f146f3500b031c9","sync_unique":"","slug":"getting-started","hidden":false,"createdAt":"2015-03-17T22:20:06.269Z","link_url":"","excerpt":"This page will help you get started with fishbaseapi. You'll be up and running in a jiffy!","githubsync":"","api":{"params":[],"url":"","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"body":"Welcome to the Fishbase API! You can use our API to access Fishbase data.\n\nWe have examples for Shell (using `curl` and `jq`). You can view code examples in the dark area to the right.\n\n\n[block:callout]\n{\n \"type\": \"warning\",\n \"body\": \"We're still in the process of filling out examples...Some routes below have examples, while some do not.\",\n \"title\": \"\"\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"danger\",\n \"title\": \"Commerical Users\",\n \"body\": \"Make sure you read information on licensing in the [license section](https://fishbaseapi.readme.io/docs/license).\"\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"info\",\n \"body\": \"Check on the status of the API at our [status page](https://ropensci.github.io/fishbasestatus/)\"\n}\n[/block]\n\n[block:callout]\n{\n \"type\": \"danger\",\n \"title\": \"FishBase Needs Your Help\",\n \"body\": \"Dear FishBase Users,\\n\\nFishBase needs help and I am writing to you because you either have at one point or another requested data to be extracted from FishBase for your own research purposes or have contributed your own data to FishBase.\\n\\nOne of the FishBase funders has had to reduce its commitment and as a result, there is a US$200,000 gap in the FishBase 2018/2019 budget, which will result in forced unpaid leave of key staff with direct consequences for the constant updating and growth of FishBase, a resource on which many of us rely.\\n\\nMany of us use FishBase regularly in our work given it provides important data on distribution, traits etc. Indeed, these data are so valuable that FishBase receives over 700,000 unique visits per month and underpins key scientific breakthroughs such as the Nature paper on rates of evolution [it’s slower in the tropics!] (see Nature (see https://www.nature.com/articles/d41586-018-05575-2 and https://www.facebook.com/FishBase/posts/1885134558216592).\\n\\nKey about FishBase is that it is free to everyone in the world, regardless of whether their institutions can afford journal subscriptions.\\n\\nFishBase co-founder Daniel Pauly once said “sending a bibliography is like providing cookbooks in a famine” and it has been the underpinning ethos of FishBase to make information available equally, regardless of where one works.\\n\\nSo for nearly 30 years, FishBase (www.fishbase.org), with its team of biologists and programmers has done just that, while constantly improving and expanding this valued resource.\\n\\nBut FishBase needs our help now. So, when you are next online on FishBase and see the donate request pop up, please donate at least $25. That’s one bottle of good VQA wine in Canada or half a carton of decent beer in Australia, 3 packs of organic Hess avocados from Loblaws or 6 latte grandes at Starbucks. If you drink more beer, use more avocado on your toast or are caffeine dependent, please consider a larger donation. IF EVERY MARINE RESEARCHER GETS ON BOARD, we can make a major contribution to FishBase. Imagine if you had to pay to access this type of information.\\n\\nIt’s time to pay it forward!\\n\\nThank you for your consideration and we all look forward to a flood of world-wide support to FishBase.\"\n}\n[/block]","updates":[],"link_external":false,"order":0,"type":"basic","__v":1,"version":"5508a8950f146f3500b031cc","category":"5508a8950f146f3500b031cd","user":"5508a87b99a1832100bf9569","isReference":false,"next":{"description":"","pages":[]},"parentDoc":null,"childrenPages":[]}
Getting Started
This page will help you get started with fishbaseapi. You'll be up and running in a jiffy!
{"_id":"5a0e4f72c01242001cac3ec1","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5508a8950f146f3500b031cd","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:54:42.277Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"<https://fishbase.ropensci.org/>","excerpt":"","slug":"base-url","type":"basic","title":"Base URL","__v":0,"parentDoc":null,"childrenPages":[]}
Base URL
{"_id":"5a0e4fba44969800124f50df","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5508a8950f146f3500b031cd","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:55:54.698Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"In addition to Fishbase, we also server [Sealifebase](http://www.sealifebase.org/) data from this API.\n\nTo use Sealifebase API instead of Fishbase, add `/sealifebase` to the base URL, like:\n\n<https://fishbase.ropensci.org/sealifebase>\n\nEverything described below should work the same for both Fishbase and Sealife base APIs.","excerpt":"","slug":"fishbase-vs-sealifebase","type":"basic","title":"Fishbase vs. Sealifebase","__v":0,"parentDoc":null,"childrenPages":[]}
Fishbase vs. Sealifebase
{"_id":"5a0e4fdcc01242001cac3ec2","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5508a8950f146f3500b031cd","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:56:28.560Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":4,"body":"[block:callout]\n{\n \"type\": \"warning\",\n \"body\": \"Database versions are supported in the Fishbase API only at this time. We may support multiple versions of Sealifebase in the future.\"\n}\n[/block]\nThe Fishbase API supports multiple different versions of the underlying database.\n\nYou can request a different database version with a HTTP header like `Accept: application/vnd.ropensci.v3+json`\n\nWhere `v3` represents \"version 3\" and so on. These versions correspond to specific dates associated with different database versions. The current versions for Fishbase are:\n\n- 201505\n- 201604\n- 201703\n- 201712\n\nThe date format `YYYYMM` is four digits for year, then two digits for month, with no spaces/characters between them.\n\nBy default, we return the latest date version.\n\nSee the [`/versions`](#versions) route for description of the different versions and their names.\n\nIn the R client `rfishbase` the database version will be controlled by a parameter or option/env var, so users won't have to pass headers themselves.","excerpt":"","slug":"database-versions","type":"basic","title":"Database versions","__v":0,"parentDoc":null,"childrenPages":[]}
Database versions
{"_id":"5a0e5003ff22d5001e9590dc","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5508a8950f146f3500b031cd","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:57:07.347Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"This is essentially a `read only` API. That is, we only allow `GET` (and `HEAD`) requests on this API.\n\nRequests of all other types will be rejected with appropriate `405` code, including `POST`, `PUT`, `COPY`, `HEAD`, `DELETE`, etc.","excerpt":"","slug":"http-methods","type":"basic","title":"HTTP Methods","__v":0,"parentDoc":null,"childrenPages":[]}
HTTP Methods
{"_id":"5a0e5015c96bc7001288e551","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5508a8950f146f3500b031cd","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:57:25.272Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"* 200 (OK) - request good!\n* 302 (Found) - the root `/`, redirects to `/heartbeat`, and `/docs` redirects to these documents\n* 400 (Bad request) - When you have a malformed request, fix it and try again\n* 404 (Not found) - When you request a route that does not exist, fix it and try again\n* 405 (Method not allowed) - When you use a prohibited HTTP method (we only allow `GET` and `HEAD`)\n* 500 (Internal server error) - Server got itself in trouble; get in touch with us. (in [Issues](https://github.com/ropensci/fishbaseapi/issues))\n\n## 400 responses will look something like\n\n```\nHTTP/1.1 400 Bad Request\nCache-Control: public, must-revalidate, max-age=60\nConnection: close\nContent-Length: 61\nContent-Type: application/json\nDate: Thu, 26 Feb 2015 23:27:57 GMT\nServer: nginx/1.7.9\nStatus: 400 Bad Request\nX-Content-Type-Options: nosniff\n\n{\n \"error\": \"invalid request\",\n \"message\": \"maximum limit is 5000\"\n}\n```\n\n## 404 responses will look something like\n\n```\nHTTP/1.1 404 Not Found\nCache-Control: public, must-revalidate, max-age=60\nConnection: close\nContent-Length: 27\nContent-Type: application/json\nDate: Thu, 26 Feb 2015 23:27:16 GMT\nServer: nginx/1.7.9\nStatus: 404 Not Found\nX-Cascade: pass\nX-Content-Type-Options: nosniff\n\n{\n \"error\": \"route not found\"\n}\n```\n\n## 405 responses will look something like (with an empty body)\n\n```\nHTTP/1.1 405 Method Not Allowed\nAccess-Control-Allow-Methods: HEAD, GET\nAccess-Control-Allow-Origin: *\nCache-Control: public, must-revalidate, max-age=60\nConnection: close\nContent-Length: 0\nContent-Type: application/json; charset=utf8\nDate: Mon, 27 Jul 2015 20:48:27 GMT\nServer: nginx/1.9.3\nStatus: 405 Method Not Allowed\nX-Content-Type-Options: nosniff\n```\n\n## 500 responses will look something like\n\n```\nHTTP/1.1 500 Internal Server Error\nCache-Control: public, must-revalidate, max-age=60\nConnection: close\nContent-Length: 24\nContent-Type: application/json\nDate: Thu, 26 Feb 2015 23:19:57 GMT\nServer: nginx/1.7.9\nStatus: 500 Internal Server Error\nX-Content-Type-Options: nosniff\n\n{\n \"error\": \"server error\"\n}\n```\n\nOccassionally you may get a MySQL error message in your `error` slot. Get in touch\nwith us if that happens as that shouldn't be happening, and we'll need to fix\nsomething on our end.","excerpt":"","slug":"response-codes","type":"basic","title":"Response Codes","__v":0,"parentDoc":null,"childrenPages":[]}
Response Codes
{"_id":"5a0e5022c96bc7001288e552","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5508a8950f146f3500b031cd","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:57:38.865Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"Response headers give the following noteable things:\n\n* allowed methods on a route\n* allowed origins\n* cache information\n* body content length\n* content type (JSON)\n* date\n* server info\n* http status code\n\n## 200 response header will look something like\n\n```\nAccess-Control-Allow-Methods: HEAD, GET\nAccess-Control-Allow-Origin: *\nCache-Control: public, must-revalidate, max-age=60\nConnection: close\nContent-Length: 10379\nContent-Type: application/json; charset=utf8\nDate: Mon, 09 Mar 2015 23:01:23 GMT\nServer: nginx/1.7.10\nStatus: 200 OK\nX-Content-Type-Options: nosniff\n```","excerpt":"","slug":"response-headers","type":"basic","title":"Response headers","__v":0,"parentDoc":null,"childrenPages":[]}
Response headers
{"_id":"5a0e503e3de7c500262d574f","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5508a8950f146f3500b031cd","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:58:06.603Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":8,"body":"Response bodies generally look like:\n\n```json\n{\n \"count\": 1,\n \"returned\": 1,\n \"data\": [\n {\n \"AnaCat\": \"potamodromous\",\n \"AquacultureRef\": 12108,\n \"Aquarium\": \"never/rarely\",\n \"AquariumFishII\": \" \",\n \"AquariumRef\": null,\n \"Author\": \"(Linnaeus, 1758)\"\n }\n ],\n \"error\": null\n}\n```\n\nResponses have 4 slots:\n\n* count: Number records found\n* returned: Number records returned\n* error: If an error did not occur this is `null`, otherwise, an error message.\n* data: The hash of data if any data returned. If no data found, this is an empty hash (hash of length zero)\n\nResponses with errors also have the same 4 slots, but no data returned, and there should be an\ninformative error message.","excerpt":"","slug":"response-bodies","type":"basic","title":"Response bodies","__v":0,"parentDoc":null,"childrenPages":[]}
Response bodies
{"_id":"5a0e5047ff22d5001e9590dd","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5508a8950f146f3500b031cd","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:58:15.143Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":9,"body":"We serve up only JSON in this API. All responses will have `Content-Type: application/json; charset=utf8`.","excerpt":"","slug":"media-types","type":"basic","title":"Media Types","__v":0,"parentDoc":null,"childrenPages":[]}
Media Types
{"_id":"5a0e5055c96bc7001288e553","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5508a8950f146f3500b031cd","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:58:29.870Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":10,"body":"The query parameters `limit` (default = 10) and `offset` (default = 0) can be used\nto toggle the number of results you get back and what record you start at. This\ndoesn't apply to some routes, which don't accept any parameters (e.g., [docs](#docs)).\n\nThe response body from the server will include data on records found in `count` and number returned in `returned`:\n\n* `\"count\": 1056`\n* `\"returned\": 10`\n\nIdeally, we'd put in a helpful [links object](http://jsonapi.org/format/#fetching-pagination) - hopefully we'll get that done in the future.","excerpt":"","slug":"pagination","type":"basic","title":"Pagination","__v":0,"parentDoc":null,"childrenPages":[]}
Pagination
{"_id":"5a0e506144969800124f50e0","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5508a8950f146f3500b031cd","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:58:41.237Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":11,"body":"We don't require any. Cheers :)","excerpt":"","slug":"authentication","type":"basic","title":"Authentication","__v":0,"parentDoc":null,"childrenPages":[]}
Authentication
{"_id":"5a0e5075c96bc7001288e554","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5508a8950f146f3500b031cd","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:59:01.023Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":12,"body":"## Common parameters\n\n+ limit (integer, optional) `number` of records to return.\n + Default: `10`\n+ offset (integer, optional) Record `number` to start at.\n + Default: `0`\n+ fields (string, optional) Comma-separated `string` of fieds to return.\n + Example: `SpecCode,Vulnerability`\n\nAbove parameters common to all routes except:\n\n* [root](#root)\n* [heartbeat](#heartbeat)\n* [docs](#docs)\n\nIn addition, these routes do not support `limit` or `offset`:\n\n* [listfields](#listfields)\n\n## Additional parameters\n\nRight now, any field that is returned from a route can also be queried on, except for the [/taxa route](#taxa), which only accepts `species` and `genus` in addition to the common parameters. All of the fields from each route are too long to list here - inspect data returned from a small data request, then change your query as desired.\n\nRight now, parameters that are not found are silently dropped. For example, if you query with `/species?foo=bar` in a query, and `foo` is not a field in `species` route, then the `foo=bar` part is ignored. We may in the future error when parameters are not found.","excerpt":"","slug":"parameters","type":"basic","title":"Parameters","__v":0,"parentDoc":null,"childrenPages":[]}
Parameters
{"_id":"5a60e144792a330012d71f55","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5508a8950f146f3500b031cd","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-01-18T18:02:44.479Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"isReference":false,"order":999,"body":"<a rel=\"license\" href=\"http://creativecommons.org/licenses/by-nc/3.0/\"><img alt=\"Creative Commons License\" style=\"border-width:0\" src=\"https://i.creativecommons.org/l/by-nc/3.0/88x31.png\" /></a><br />Fishbase is licensed under a <a rel=\"license\" href=\"http://creativecommons.org/licenses/by-nc/3.0/\">Creative Commons Attribution-NonCommercial 3.0 Unported License</a>.\n\nSee the bottom of <a href=\"http://www.fishbase.us/\">the Fishbase website</a> for details on usage.\n\nThe Fishbase API follows the same license as Fishbase. It is free for non-commercial use with attribution as defined by the terms of the CC-BY-NC license (see above). Commercial users should first contact Fishbase maintainers at <a href=\"http://www.fishbase.us/mail/MailForm.php\">www.fishbase.us/mail/MailForm.php</a>.","excerpt":"","slug":"license","type":"basic","title":"License","__v":0,"parentDoc":null,"childrenPages":[]}
License
{"_id":"5a0e2ff344969800124f4d3c","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:40:19.661Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"shell","code":"curl -L https://fishbase.ropensci.org/heartbeat/ | jq ."}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"routes\": [\n \"/docs/:table?\",\n \"/heartbeat\",\n \"/mysqlping\",\n \"/listfields\",\n \"/classes/:id?<params>\",\n \"/comnames?<params>\",\n \"/country?<params>\",\n \"/countrysub?<params>\",\n \"/countrysubref/:id?<params>\",\n \"/countref/:id?<params>\",\n \"/ecology/:id?<params>\",\n \"/ecosystemref/:id?<params>\",\n \"/fecundity?<params>\",\n \"/fooditems?<params>\",\n \"/intrcase?<params>\",\n \"/larvae?<params>\",\n \"/listfields/:id?<params>\",\n \"/matrix/:id?<params>\",\n \"/maturity?<params>\",\n \"/morphdat/:id?<params>\",\n \"/morphmet/:id?<params>\",\n \"/myersdata?<params>\",\n \"/myersrecruitmentdatabase/:id?<params>\",\n \"/orders/:id?<params>\",\n \"/oxygen/:id?<params>\",\n \"/popchar?<params>\",\n \"/popgrowth/:id?<params>\",\n \"/poplf?<params>\",\n \"/popll/:id?<params>\",\n \"/popqb/:id?<params>\",\n \"/poplw/:id?<params>\",\n \"/predats?<params>\",\n \"/ration/:id?<params>\",\n \"/refrens/:id?<params>\",\n \"/reproduc/:id?<params>\",\n \"/spawning?<params>\",\n \"/speed/:id?<params>\",\n \"/stocks?<params>\",\n \"/swimming/:id?<params>\",\n \"/synonyms?<params>\",\n \"/faoareas/:id?<params>\",\n \"/faoarref/:id?<params>\",\n \"/genera/:id?<params>\",\n \"/species/:id?<params>\",\n \"/eggs/:id?<params>\",\n \"/eggdev/:id?<params>\",\n \"/estimate/:id?<params>\",\n \"/families/:id?<params>\",\n \"/taxa?<params>\",\n \"/ecosystem?<params>\",\n \"/diet?<params>\"\n ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":"/heartbeat","method":"get"},"isReference":false,"order":0,"body":"`/` redirects to this route - if using `curl` on the command line make sure to pass the `-L` flag to follow redirects.","excerpt":"Lists all the routes, and gives some indicaion of what can be passed to them.","slug":"heartbeat","type":"get","title":"heartbeat","__v":1,"parentDoc":null,"childrenPages":[]}
getheartbeat
Lists all the routes, and gives some indicaion of what can be passed to them.
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a0e30d9c96bc7001288e1b2","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:44:09.744Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"shell","code":"curl https://fishbase.ropensci.org/docs/ | jq ."}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"count\": 38,\n \"returned\": 38,\n \"data\": [\n {\n \"table\": \"heartbeat\",\n \"description\": \"API endpoint to confirm that the API is up. Lists all available endpoints\",\n \"links\": null\n },\n {\n \"table\": \"comnames\",\n \"description\": \"Table of common names\",\n \"links\": null\n },\n {\n \"table\": \"countref\",\n \"description\": \"The COUNTREF table holds country-specific information such as the official names in English, French and Spanish, the UN statistical name and code number, name and coordinates of the capital city, FAO areas, aquaculture production, shelf area, languages, international bodies and legal instruments, etc.\",\n \"links\": \"http://www.fishbase.org/manual/english/fishbasethe_countref_table.htm\"\n },\n ...\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":"/docs"},"isReference":false,"order":1,"body":"","excerpt":"","slug":"docs","type":"get","title":"docs","__v":0,"parentDoc":null,"childrenPages":[]}
getdocs
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a0e312bff22d5001e958e21","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:45:31.049Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"shell","code":"curl https://fishbase.ropensci.org/docs/country/ | jq ."}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"count\": 36,\n \"returned\": 36,\n \"data\": [\n {\n \"table_name\": \"country\",\n \"column_name\": \"autoctr\"\n },\n {\n \"table_name\": \"country\",\n \"column_name\": \"Stockcode\"\n },\n {\n \"table_name\": \"country\",\n \"column_name\": \"C_Code\"\n },\n ...\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a0e312bff22d5001e958e22","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"table"}],"url":"/docs/:table","method":"get"},"isReference":false,"order":2,"body":"","excerpt":"","slug":"docs-by-table","type":"get","title":"docs by table","__v":3,"parentDoc":null,"childrenPages":[]}
getdocs by table
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a0e31403de7c500262d53f5","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:45:52.129Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"shell","code":"curl \"https://fishbase.ropensci.org/versions\" | jq ."},{"language":"text","code":""}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"data\": [\n {\n \"v1\": {\n \"name\": \"201505\",\n \"date_released\": \"2015-05-20\"\n },\n \"v2\": {\n \"name\": \"201604\",\n \"date_released\": \"2016-04-28\"\n },\n \"v3\": {\n \"name\": \"201703\",\n \"date_released\": \"2017-03-31\"\n }\n }\n ],\n \"error\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":"/versions"},"isReference":false,"order":3,"body":"","excerpt":"Get Fishbase database versions.","slug":"versions","type":"get","title":"versions","__v":0,"parentDoc":null,"childrenPages":[]}
getversions
Get Fishbase database versions.
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a0e3156ff22d5001e958e24","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:46:14.360Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"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":""},{"status":400,"language":"json","code":"{}","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":"","auth":"required","params":[{"_id":"5a0e4a7cc01242001cac3e74","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a0e4a7cc01242001cac3e73","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a0e4a7cc01242001cac3e72","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1cdcc167d310001245b37d","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/comnames","method":"get"},"isReference":false,"order":4,"body":"","excerpt":"","slug":"comnames","type":"get","title":"comnames","__v":2,"parentDoc":null,"childrenPages":[]}
getcomnames
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a0e3169ff22d5001e958e25","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:46:33.912Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"shell","code":"curl 'https://fishbase.ropensci.org/countref?limit=1&fields=Language,Marine,CenterLat,CenterLong' | jq ."}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"count\": 311,\n \"returned\": 1,\n \"data\": [\n {\n \"C_Code\": null,\n \"Language\": \"Pashto\",\n \"CenterLat\": 33.8331904902,\n \"CenterLong\": 66.02553389590001,\n \"Marine\": 0\n }\n ],\n \"error\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e4d6ffbd088001c87d32c","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4d6ffbd088001c87d32b","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e4d6ffbd088001c87d32a","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e4d6ffbd088001c87d329","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/countref"},"isReference":false,"order":5,"body":"","excerpt":"","slug":"countref","type":"get","title":"countref","__v":2,"parentDoc":null,"childrenPages":[]}
getcountref
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a0e31813de7c500262d53f6","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:46:57.876Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"name":null,"language":"shell","code":"curl 'https://fishbase.ropensci.org/country?limit=1&fields=SpecCode,Status,Saltwater,Land' | jq ."}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"count\": 186994,\n \"returned\": 1,\n \"data\": [\n {\n \"SpecCode\": 18,\n \"Status\": \"native\",\n \"Saltwater\": 1,\n \"Land\": 0\n }\n ],\n \"error\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e4da109ac8d003ef62986","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"},{"_id":"5a1e4e091f1235001296604e","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4e7e721b9a0026bbf606","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e52ef09ac8d003ef62a75","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"}],"url":"/country"},"isReference":false,"order":6,"body":"","excerpt":"","slug":"country","type":"get","title":"country","__v":6,"parentDoc":null,"childrenPages":[]}
getcountry
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a0e318ec01242001cac3c17","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:47:10.261Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"shell","code":"curl 'https://fishbase.ropensci.org/diet?limit=1' | jq ."}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"count\": 37721,\n \"returned\": 1,\n \"data\": [\n {\n \"DietCode\": 1,\n \"StockCode\": 79,\n \"Speccode\": 69,\n \"DietRefNo\": 9604,\n \"SampleStage\": \"recruits/juv.\",\n \"SampleSize\": 37,\n \"YearStart\": null,\n \"YearEnd\": null,\n \"January\": 0,\n \"February\": 0,\n \"March\": 0,\n \"April\": -1,\n \"May\": -1,\n \"June\": -1,\n \"July\": 0,\n \"August\": 0,\n \"September\": 0,\n \"October\": 0,\n \"November\": 0,\n \"December\": 0,\n \"C_Code\": \"826\",\n \"Locality\": \"Off the west coast of the Isle of Man, 1977-1978\",\n \"E_Code\": 235,\n \"Method\": null,\n \"MethodType\": null,\n \"Remark\": \"Length type derived from given length in Species table.\",\n \"OtherItems\": 0.1,\n \"PercentEmpty\": null,\n \"Troph\": 3.83,\n \"seTroph\": 0.37,\n \"SizeMin\": 30,\n \"SizeMax\": 39,\n \"SizeType\": \"TL\",\n \"FishLength\": 34.5,\n \"Entered\": 34,\n \"DateEntered\": \"1995-07-29T00:00:00.000Z\",\n \"Modified\": null,\n \"DateModified\": \"2010-12-17T00:00:00.000Z\",\n \"Expert\": null,\n \"DateChecked\": null,\n \"FoodI\": \"zoobenthos\",\n \"FoodII\": \"mollusks\",\n \"FoodIII\": \"bivalves\",\n \"Stage\": \"n.a./others\",\n \"DietPercent\": 1,\n \"ItemName\": \"gastropods\",\n \"Comment\": \"0.8% bivalves/gastropods incl. 0.1% euphausiids, 0.1% unid. organisms\",\n \"DietSpeccode\": null,\n \"AlphaCode\": \"GAS\",\n \"PreyTroph\": null,\n \"PreySeTroph\": null,\n \"PreyRemark\": null\n }\n ],\n \"error\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e4db009ac8d003ef62987","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"},{"_id":"5a1e4e131f1235001296604f","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4e8a09ac8d003ef629c0","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"}],"url":"/diet"},"isReference":false,"order":7,"body":"","excerpt":"","slug":"diet","type":"get","title":"diet","__v":7,"parentDoc":null,"childrenPages":[]}
getdiet
Query Params
limit:
integer10
number of records to return
offset:
integer0
record number to start at
Headers
Accept:
stringapplication/vnd.ropensci.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a0e31a5ff22d5001e958e2c","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:47:33.467Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"shell","code":"curl 'https://fishbase.ropensci.org/ecology?limit=1&fields=SpecCode,FeedingType,FoodRef,HabitatsRef' | jq ."}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"count\": 11233,\n \"returned\": 1,\n \"data\": [\n {\n \"SpecCode\": 2,\n \"StockCode\": null,\n \"HabitatsRef\": 87,\n \"FeedingType\": \"browsing on substrate\",\n \"FoodRef\": 30469\n }\n ],\n \"error\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e4dbf1f1235001296604c","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"},{"_id":"5a1e4e1bfbd088001c87d32d","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4e9a721b9a0026bbf607","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e5301721b9a0026bbf6ba","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"}],"url":"/ecology"},"isReference":false,"order":8,"body":"","excerpt":"","slug":"ecology","type":"get","title":"ecology","__v":6,"parentDoc":null,"childrenPages":[]}
getecology
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a0e31b344969800124f4dc7","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:47:47.833Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"shell","code":"curl https://fishbase.ropensci.org/ecosystem?limit=1 | jq ."}]},"results":{"codes":[{"name":"","code":"{\n \"count\": 143093,\n \"returned\": 1,\n \"data\": [\n {\n \"autoctr\": 1,\n \"E_CODE\": 1,\n \"EcosystemRefno\": 50628,\n \"Speccode\": 549,\n \"Stockcode\": 565,\n \"Status\": \"native\",\n \"Abundance\": null,\n \"LifeStage\": \"adults\",\n \"Remarks\": null,\n \"Entered\": 1,\n \"Dateentered\": \"2007-11-12T00:00:00.000Z\",\n \"Modified\": 949,\n \"Datemodified\": \"2007-11-12T00:00:00.000Z\",\n \"Expert\": 949,\n \"Datechecked\": null,\n \"WebURL\": null,\n \"TS\": null,\n \"EcosystemName\": \"Amazon\",\n \"EcosystemType\": \"River (basin)\",\n \"Location\": \"South America\",\n \"Salinity\": \"freshwater\",\n \"RiverLength\": 6515,\n \"Area\": null,\n \"SizeRef\": 6232,\n \"DrainageArea\": 7050000,\n \"NorthernLat\": 1,\n \"NrangeNS\": \"N\",\n \"SouthernLat\": 16,\n \"SrangeNS\": \"S\",\n \"WesternLat\": 79,\n \"WrangeEW\": \"W\",\n \"EasternLat\": 49,\n \"ErangeEW\": \"W\",\n \"Climate\": \"tropical\",\n \"AverageDepth\": null,\n \"MaxDepth\": null,\n \"DepthRef\": null,\n \"TempSurface\": null,\n \"TempSurfaceMap\": null,\n \"TempDepth\": null,\n \"Description\": null,\n \"EcosystemURL1\": null,\n \"EcosystemURL2\": null,\n \"EcosystemURL3\": null,\n \"DateEntered\": \"1993-11-24T00:00:00.000Z\",\n \"DateModified\": \"2016-01-11T00:00:00.000Z\",\n \"DateChecked\": \"2012-06-06T00:00:00.000Z\"\n }\n ],\n \"error\": null\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","auth":"required","params":[{"_id":"5a1e4de01f1235001296604d","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"},{"_id":"5a1e4e24721b9a0026bbf5f3","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4ea51f12350012966050","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e530909ac8d003ef62a77","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"}],"url":"/ecosystem"},"isReference":false,"order":9,"body":"","excerpt":"","slug":"ecosystem","type":"get","title":"ecosystem","__v":7,"parentDoc":null,"childrenPages":[]}
getecosystem
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a0e31f6c01242001cac3c18","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:48:54.559Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"shell","code":"curl https://fishbase.ropensci.org/faoareas?limit=1 | jq ."}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"count\": 60522,\n \"returned\": 1,\n \"data\": [\n {\n \"autoctr\": 483,\n \"AreaCode\": 1,\n \"SpecCode\": 2,\n \"StockCode\": 1,\n \"Status\": \"endemic\",\n \"Entered\": 2,\n \"DateEntered\": \"1990-10-19T00:00:00.000Z\",\n \"Modified\": 675,\n \"DateModified\": \"2011-02-11T17:16:45.000Z\",\n \"Expert\": null,\n \"DateChecked\": null,\n \"TS\": null\n }\n ],\n \"error\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e4e2e64c7360012a285d3","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4eb7721b9a0026bbf608","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e5312fbd088001c87d3fa","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e544b1f12350012966069","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/faoareas"},"isReference":false,"order":10,"body":"","excerpt":"","slug":"faoareas","type":"get","title":"faoareas","__v":7,"parentDoc":null,"childrenPages":[]}
getfaoareas
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a0e3218c01242001cac3c19","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:49:28.461Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"shell","code":"curl https://fishbase.ropensci.org/faoareas/8 | jq ."}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"count\": 8,\n \"returned\": 8,\n \"data\": [\n {\n \"autoctr\": 52806,\n \"AreaCode\": 8,\n \"SpecCode\": 238,\n \"StockCode\": 252,\n \"Status\": \"native\",\n \"Entered\": 1016,\n \"DateEntered\": \"2003-07-22T00:00:00.000Z\",\n \"Modified\": null,\n \"DateModified\": \"2003-07-22T00:00:00.000Z\",\n \"Expert\": null,\n \"DateChecked\": null,\n \"TS\": null\n },\n ...","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a0e322e3de7c500262d53f7","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"id"},{"_id":"5a1e4e3e721b9a0026bbf604","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4ed21f12350012966051","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e531f721b9a0026bbf6bb","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e54541f1235001296606a","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/faoareas/:id"},"isReference":false,"order":11,"body":"","excerpt":"","slug":"faoareas-by-id","type":"get","title":"faoareas by id","__v":8,"parentDoc":null,"childrenPages":[]}
getfaoareas by id
Path Params
id:
required
string
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a0e324bff22d5001e958e2d","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:50:19.847Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"shell","code":"curl https://fishbase.ropensci.org/faoarref/?fields=AreaCode,FAO,Note,Shelf,EEZarea,LatDeg,LongDeg&limit=1 | jq ."}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"count\": 28,\n \"returned\": 1,\n \"data\": [\n {\n \"AreaCode\": 1,\n \"FAO\": \"Africa-Inland Waters\",\n \"Note\": \"Complete\",\n \"Shelf\": 1326,\n \"EEZarea\": 11981,\n \"LatDeg\": 7,\n \"LongDeg\": 20\n }\n ],\n \"error\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e4ef009ac8d003ef629d2","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4ef009ac8d003ef629d1","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e532a721b9a0026bbf6bc","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e545f1f1235001296606c","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/faoarref"},"isReference":false,"order":12,"body":"","excerpt":"","slug":"faoarref","type":"get","title":"faoarref","__v":5,"parentDoc":null,"childrenPages":[]}
getfaoarref
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a0e326344969800124f4dd1","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:50:43.356Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"shell","code":"curl https://fishbase.ropensci.org/faoarref/18?fields=AreaCode,FAO,Note,Shelf,EEZarea,LatDeg,LongDeg | jq ."}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"count\": 1,\n \"returned\": 1,\n \"data\": [\n {\n \"AreaCode\": 18,\n \"FAO\": \"Arctic Ocean\",\n \"Note\": null,\n \"Shelf\": 7336000,\n \"EEZarea\": null,\n \"LatDeg\": 77,\n \"LongDeg\": 165\n }\n ],\n \"error\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a0e326344969800124f4dd2","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"id"},{"_id":"5a1e4f1e64c7360012a285e5","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4f1e64c7360012a285e4","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e5333fbd088001c87d3fb","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e54671f1235001296606d","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/faoarref/:id"},"isReference":false,"order":13,"body":"","excerpt":"","slug":"faoarref-by-id","type":"get","title":"faoarref by id","__v":6,"parentDoc":null,"childrenPages":[]}
getfaoarref by id
Path Params
id:
required
string
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a0e327744969800124f4dd3","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:51:03.260Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"shell","code":"curl https://fishbase.ropensci.org/fecundity?limit=2&fields=SpecCode,FecundityMin,FecundityMax,LengthTypeFecMin,LengthTypeFecMax | jq ."}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"count\": 3110,\n \"returned\": 2,\n \"data\": [\n {\n \"SpecCode\": 2,\n \"FecundityMin\": null,\n \"LengthTypeFecMin\": null,\n \"FecundityMax\": null,\n \"LengthTypeFecMax\": null\n },\n {\n \"SpecCode\": 2,\n \"FecundityMin\": 300,\n \"LengthTypeFecMin\": null,\n \"FecundityMax\": 1500,\n \"LengthTypeFecMax\": null\n }\n ],\n \"error\": null\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e4f3909ac8d003ef629d4","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4f3909ac8d003ef629d3","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e533c09ac8d003ef62a78","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e546e64c7360012a286a2","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/fecundity"},"isReference":false,"order":14,"body":"","excerpt":"","slug":"fecundity","type":"get","title":"fecundity","__v":5,"parentDoc":null,"childrenPages":[]}
getfecundity
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a0e328344969800124f4dd4","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:51:15.321Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e4f52fbd088001c87d384","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4f52fbd088001c87d383","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e5346fbd088001c87d3fc","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e5476fbd088001c87d423","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/fooditems"},"isReference":false,"order":15,"body":"","excerpt":"","slug":"fooditems","type":"get","title":"fooditems","__v":4,"parentDoc":null,"childrenPages":[]}
getfooditems
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e328f3de7c500262d5408","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:51:27.534Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e4f6c09ac8d003ef629d7","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4f6c09ac8d003ef629d6","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e5359721b9a0026bbf6bd","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e547f64c7360012a286d7","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/genera"},"isReference":false,"order":16,"body":"","excerpt":"","slug":"genera","type":"get","title":"genera","__v":4,"parentDoc":null,"childrenPages":[]}
getgenera
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e32a13de7c500262d5409","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:51:45.189Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a0e32a13de7c500262d540a","ref":"","in":"path","required":true,"desc":"","default":"","type":"string","name":"id"},{"_id":"5a1e4f841f12350012966053","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4f841f12350012966052","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e536064c7360012a2868c","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e549f09ac8d003ef62a8e","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/genera/:id"},"isReference":false,"order":17,"body":"","excerpt":"","slug":"genera-by-id","type":"get","title":"genera by id","__v":5,"parentDoc":null,"childrenPages":[]}
getgenera by id
Path Params
id:
required
string
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e32b6c96bc7001288e27f","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:52:06.208Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e4fb8fbd088001c87d386","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4fb8fbd088001c87d385","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e5366fbd088001c87d3fd","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e54a7a2d8900012710060","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/intrcase"},"isReference":false,"order":18,"body":"","excerpt":"","slug":"intrcase","type":"get","title":"intrcase","__v":4,"parentDoc":null,"childrenPages":[]}
getintrcase
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e32c13de7c500262d540b","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:52:17.433Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e54af09ac8d003ef62a8f","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/listfields"},"isReference":false,"order":19,"body":"","excerpt":"","slug":"listfields","type":"get","title":"listfields","__v":2,"parentDoc":null,"childrenPages":[]}
getlistfields
Headers
Accept:
stringapplication/vnd.ropensci.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e32cd3de7c500262d540c","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:52:29.765Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e4fd564c7360012a285fb","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4fd564c7360012a285fa","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e537364c7360012a2868d","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e54b7fbd088001c87d425","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/maturity"},"isReference":false,"order":20,"body":"","excerpt":"","slug":"maturity","type":"get","title":"maturity","__v":4,"parentDoc":null,"childrenPages":[]}
getmaturity
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e32d9c01242001cac3c1a","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:52:41.424Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e4ff3fbd088001c87d3bc","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e4ff3fbd088001c87d3bb","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e537cfbd088001c87d3fe","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e54bda2d8900012710061","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/morphdat"},"isReference":false,"order":21,"body":"","excerpt":"","slug":"morphdat","type":"get","title":"morphdat","__v":4,"parentDoc":null,"childrenPages":[]}
getmorphdat
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e32e444969800124f4de5","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:52:52.185Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e50081f12350012966057","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e50081f12350012966056","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e538409ac8d003ef62a79","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e54c309ac8d003ef62a90","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/morphmet"},"isReference":false,"order":22,"body":"","excerpt":"","slug":"morphmet","type":"get","title":"morphmet","__v":4,"parentDoc":null,"childrenPages":[]}
getmorphmet
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e32f03de7c500262d540d","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:53:04.023Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e5022721b9a0026bbf64f","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e5022721b9a0026bbf64e","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e538b09ac8d003ef62a7a","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e54cc1f1235001296606f","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/occurrence"},"isReference":false,"order":23,"body":"","excerpt":"","slug":"occurrence","type":"get","title":"occurrence","__v":4,"parentDoc":null,"childrenPages":[]}
getoccurrence
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e32f8c01242001cac3c1b","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:53:12.188Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e50361f12350012966059","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e50361f12350012966058","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e5395fbd088001c87d400","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e54d31f12350012966070","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/oxygen"},"isReference":false,"order":24,"body":"","excerpt":"","slug":"oxygen","type":"get","title":"oxygen","__v":4,"parentDoc":null,"childrenPages":[]}
getoxygen
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e4611c01242001cac3e05","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:14:41.652Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e504b09ac8d003ef629dd","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e504b09ac8d003ef629dc","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e539f64c7360012a2868e","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e54da64c7360012a286d9","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/popchar"},"isReference":false,"order":25,"body":"","excerpt":"","slug":"popchar","type":"get","title":"popchar","__v":4,"parentDoc":null,"childrenPages":[]}
getpopchar
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e461cc96bc7001288e43f","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:14:52.230Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e506209ac8d003ef629df","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e506209ac8d003ef629de","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e53a8a2d8900012710029","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e54e209ac8d003ef62a91","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/popgrowth"},"isReference":false,"order":26,"body":"","excerpt":"","slug":"popgrowth","type":"get","title":"popgrowth","__v":4,"parentDoc":null,"childrenPages":[]}
getpopgrowth
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e46283de7c500262d55ac","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:15:04.641Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e507bfbd088001c87d3bf","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e507bfbd088001c87d3be","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e53b11f12350012966067","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e54e9a2d8900012710062","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/poplf"},"isReference":false,"order":27,"body":"","excerpt":"","slug":"poplf","type":"get","title":"poplf","__v":4,"parentDoc":null,"childrenPages":[]}
getpoplf
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e4631c01242001cac3e06","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:15:13.504Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e50971f1235001296605d","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e50971f1235001296605c","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e53b9a2d890001271002a","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e54ef1f12350012966071","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/popll"},"isReference":false,"order":28,"body":"","excerpt":"","slug":"popll","type":"get","title":"popll","__v":4,"parentDoc":null,"childrenPages":[]}
getpopll
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e463cff22d5001e958fcd","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:15:24.366Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e50b1721b9a0026bbf661","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e50b1721b9a0026bbf660","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e53c1a2d890001271002b","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e54f7a2d8900012710063","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/popqb"},"isReference":false,"order":29,"body":"","excerpt":"","slug":"popqb","type":"get","title":"popqb","__v":4,"parentDoc":null,"childrenPages":[]}
getpopqb
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e4647c01242001cac3e07","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:15:35.453Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e50ca1f1235001296605f","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e50ca1f1235001296605e","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e53c81f12350012966068","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e5500fbd088001c87d426","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/poplw"},"isReference":false,"order":30,"body":"","excerpt":"","slug":"poplw","type":"get","title":"poplw","__v":4,"parentDoc":null,"childrenPages":[]}
getpoplw
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e4677c96bc7001288e450","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:16:23.769Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e50df64c7360012a2860d","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e50df64c7360012a2860c","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e53d0fbd088001c87d402","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e55091f12350012966072","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/predats"},"isReference":false,"order":31,"body":"","excerpt":"","slug":"predats","type":"get","title":"predats","__v":4,"parentDoc":null,"childrenPages":[]}
getpredats
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e46823de7c500262d55ad","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:16:34.520Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e50fe64c7360012a2860f","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e50fe64c7360012a2860e","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e53d9fbd088001c87d403","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e55111f12350012966073","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/ration"},"isReference":false,"order":32,"body":"","excerpt":"","slug":"ration","type":"get","title":"ration","__v":4,"parentDoc":null,"childrenPages":[]}
getration
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e468d44969800124f5031","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:16:45.783Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e511309ac8d003ef62a4a","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e511309ac8d003ef62a49","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e53e3721b9a0026bbf6be","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e551afbd088001c87d428","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/refrens"},"isReference":false,"order":33,"body":"","excerpt":"","slug":"refrens","type":"get","title":"refrens","__v":4,"parentDoc":null,"childrenPages":[]}
getrefrens
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e46a3c01242001cac3e09","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:17:07.355Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e512d09ac8d003ef62a4c","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e512d09ac8d003ef62a4b","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e53eefbd088001c87d405","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e552164c7360012a286da","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/reproduc"},"isReference":false,"order":34,"body":"","excerpt":"","slug":"reproduc","type":"get","title":"reproduc","__v":4,"parentDoc":null,"childrenPages":[]}
getreproduc
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e46adff22d5001e958fe2","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:17:17.201Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e51471f12350012966061","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e51471f12350012966060","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e53f609ac8d003ef62a7b","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e552dfbd088001c87d439","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/species"},"isReference":false,"order":35,"body":"","excerpt":"","slug":"species","type":"get","title":"species","__v":4,"parentDoc":null,"childrenPages":[]}
getspecies
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e46bd44969800124f5032","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:17:33.349Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e515c09ac8d003ef62a4e","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e515c09ac8d003ef62a4d","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e53ff64c7360012a2868f","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e553664c7360012a286db","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"},{"_id":"5a1ece294f7a13003cdcb3c0","ref":"","in":"path","required":true,"desc":"","default":"","type":"int","name":"id"}],"url":"/species/:id"},"isReference":false,"order":36,"body":"","excerpt":"","slug":"species-by-id","type":"get","title":"species by id","__v":5,"parentDoc":null,"childrenPages":[]}
getspecies by id
Path Params
id:
required
integer
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e46c7ff22d5001e959017","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:17:43.493Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e517309ac8d003ef62a50","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e517309ac8d003ef62a4f","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e540509ac8d003ef62a7c","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e553da2d8900012710098","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/spawning"},"isReference":false,"order":37,"body":"","excerpt":"","slug":"spawning","type":"get","title":"spawning","__v":4,"parentDoc":null,"childrenPages":[]}
getspawning
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e46d044969800124f5033","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:17:52.987Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e5188fbd088001c87d3c1","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e5188fbd088001c87d3c0","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e540cfbd088001c87d406","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e554509ac8d003ef62a92","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/speed"},"isReference":false,"order":38,"body":"","excerpt":"","slug":"speed","type":"get","title":"speed","__v":4,"parentDoc":null,"childrenPages":[]}
getspeed
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e46dbc96bc7001288e451","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:18:03.535Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e51a31f12350012966063","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e51a31f12350012966062","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e5413fbd088001c87d407","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e554c09ac8d003ef62a93","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/stocks"},"isReference":false,"order":39,"body":"","excerpt":"","slug":"stocks","type":"get","title":"stocks","__v":4,"parentDoc":null,"childrenPages":[]}
getstocks
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e46e6ff22d5001e959018","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:18:14.327Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e51b71f12350012966065","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e51b71f12350012966064","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e541909ac8d003ef62a7d","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e5556a2d89000127100a9","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/swimming"},"isReference":false,"order":40,"body":"","excerpt":"","slug":"swimming","type":"get","title":"swimming","__v":4,"parentDoc":null,"childrenPages":[]}
getswimming
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e46f1ff22d5001e959019","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:18:25.132Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e51e3721b9a0026bbf673","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e51e3721b9a0026bbf672","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e542064c7360012a28691","ref":"","in":"query","required":false,"desc":"Comma-separated string of fields to return","default":"","type":"string","name":"fields"},{"_id":"5a1e55aefbd088001c87d43b","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/synonyms"},"isReference":false,"order":41,"body":"","excerpt":"","slug":"synonyms","type":"get","title":"synonyms","__v":4,"parentDoc":null,"childrenPages":[]}
getsynonyms
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.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5a0e46fdc01242001cac3e0b","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","category":"5a0e2fdcc96bc7001288e17d","user":"5508a87b99a1832100bf9569","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T02:18:37.461Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5a1e51f509ac8d003ef62a72","ref":"","in":"query","required":false,"desc":"number of records to return","default":"10","type":"int","name":"limit"},{"_id":"5a1e51f509ac8d003ef62a71","ref":"","in":"query","required":false,"desc":"record number to start at","default":"0","type":"int","name":"offset"},{"_id":"5a1e55b51f12350012966084","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v3+json","type":"string","name":"Accept"}],"url":"/taxa"},"isReference":false,"order":42,"body":"","excerpt":"","slug":"taxa","type":"get","title":"taxa","__v":3,"parentDoc":null,"childrenPages":[]}
gettaxa
Query Params
limit:
integer10
number of records to return
offset:
integer0
record number to start at
Headers
Accept:
stringapplication/vnd.ropensci.v3+json
Version accept header
Definition
{{ api_url }}{{ page_api_url }}