{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/countref","auth":"required","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":""}]},"settings":"","params":[{"name":"limit","type":"int","default":"10","desc":"number of records to return","required":false,"in":"query","ref":"","_id":"5a1e4d6ffbd088001c87d32c"},{"name":"offset","type":"int","default":"0","desc":"record number to start at","required":false,"in":"query","ref":"","_id":"5a1e4d6ffbd088001c87d32b"},{"name":"fields","type":"string","default":"","desc":"Comma-separated string of fields to return","required":false,"in":"query","ref":"","_id":"5a1e4d6ffbd088001c87d32a"},{"name":"Accept","type":"string","default":"application/vnd.ropensci.v8+json","desc":"Version accept header","required":false,"in":"header","ref":"","_id":"5a1e4d6ffbd088001c87d329"}]},"next":{"description":"","pages":[]},"title":"countref","type":"endpoint","slug":"countref","excerpt":"","body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Additional Query Parameters\",\n  \"body\": \"In addition to the query parameters listed (limit, offset, fields) you should be able to query on any of the keys in the response body.\"\n}\n[/block]","updates":[],"order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a0e3169ff22d5001e958e25","project":"5508a8940f146f3500b031c9","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5508a8950f146f3500b031cd","5a0e2e283bb0d9001c09e3e1","5a0e2f9844969800124f4d3a","5a0e2fdcc96bc7001288e17d"],"_id":"5508a8950f146f3500b031cc","__v":4,"createdAt":"2015-03-17T22:20:05.001Z","releaseDate":"2015-03-17T22:20:05.001Z","project":"5508a8940f146f3500b031c9"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Routes","slug":"heartbeat","order":1,"from_sync":false,"reference":false,"_id":"5a0e2fdcc96bc7001288e17d","project":"5508a8940f146f3500b031c9","version":"5508a8950f146f3500b031cc","createdAt":"2017-11-17T00:39:56.122Z","__v":0},"user":"5508a87b99a1832100bf9569","createdAt":"2017-11-17T00:46:33.912Z","githubsync":"","__v":5,"parentDoc":null}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

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

Headers

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

Examples


Result Format


Documentation

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

User Information

Try It Out

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