{"_id":"5a0e31813de7c500262d53f6","project":"5508a8940f146f3500b031c9","version":{"_id":"5508a8950f146f3500b031cc","__v":4,"project":"5508a8940f146f3500b031c9","createdAt":"2015-03-17T22:20:05.001Z","releaseDate":"2015-03-17T22:20:05.001Z","categories":["5508a8950f146f3500b031cd","5a0e2e283bb0d9001c09e3e1","5a0e2f9844969800124f4d3a","5a0e2fdcc96bc7001288e17d"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5a0e2fdcc96bc7001288e17d","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-11-17T00:39:56.122Z","from_sync":false,"order":1,"slug":"heartbeat","title":"Routes"},"user":"5508a87b99a1832100bf9569","githubsync":"","__v":9,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-17T00:46:57.876Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"code":"curl 'https://fishbase.ropensci.org/country?limit=1&fields=SpecCode,Status,Saltwater,Land' |  jq .","language":"shell","name":null}]},"results":{"codes":[{"name":"","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}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"5a1e4da109ac8d003ef62986","ref":"","in":"header","required":false,"desc":"Version accept header","default":"application/vnd.ropensci.v8+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":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Additional Query Parameters\",\n  \"body\": \"In addition to the query parameters listed (limit, offset, fields) you should be able to query on any of the keys in the response body.\"\n}\n[/block]","excerpt":"","slug":"country","type":"endpoint","title":"country"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

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

Headers

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

Examples


Result Format


Documentation

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

User Information

Try It Out

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