31:Ta50,apiResponse = { //if JWT is provided, add it to request options to make an authenticated request let reqOptions = {}; if (input.jwt) { let hdr = new Headers(); hdr.append('Content-Type','application/json'); hdr.append('Authorization',('Bearer '+input.jwt)); reqOptions = {method:endpoint.method,headers:hdr}; }; // get a single page of results only, or else get multiple pages (up to max total record limit) if (input.multiPage==='false') { endpoint['reqURL'] = endpoint.baseURL+(input.params?'?'+input.params:''); return fetch(endpoint.reqURL, reqOptions) .then(response=>{return response.json()}); } else { let combinedResults = []; let paramString = new URLSearchParams(input.params); paramString.delete('page'); // delete this for now; will set pages as we iterate through pages paramString.delete('per_page'); // delete this for now; will use the maxRec.per_page instead endpoint['reqURL'] = endpoint.baseURL+(paramString?'?'+paramString:''); // First, get a total record count, which will indicate how many pages need to be fetched. paramString.set('page','1'); paramString.set('per_page','0'); return fetch(endpoint.reqURL, reqOptions) .then(response=>{return response.json()}) .then(data=>{return data.total_results}) .then(ttlRecs=>{ if (ttlRecs) { // Once we know how many records there are, we can calculate total pages. // Then we will iterate through each page, with a small delay between each request. if (ttlRecs > maxRecs.total) { ttlRecs = maxRecs.total; }; let ttlPages = Math.ceil(ttlRecs/maxRecs.perPage); let aryPromises = []; let cumDelay = 0; for (let p=1; p<=ttlPages; p++) { paramString.set('page',p); paramString.set('per_page',maxRecs.perPage); let prom = new Promises.delay(cumDelay,{ url:endpoint.baseURL+(paramString?'?'+paramString:''), options:reqOptions, }) .then(req=>{ return fetch(req.url,req.options) .then(response=>{return response.json()}) .then(data=>{return data.results}); }); aryPromises.push(prom); cumDelay+=apiRequestDelay; }; return Promise.all(aryPromises).then(results=>{ for (let r of results) { combinedResults = [...combinedResults,...r] }; return { total_results:combinedResults.length, page:results.length, per_page:maxRecs.perPage, results:combinedResults }; }) } }) } }32:[] 2f:{"title":"iNaturalist API Example #1","cells":[{"id":0,"value":"md`# iNaturalist API Example #1`","pinned":false,"hidden":false,"mode":"ojs"},{"id":240,"value":"html`

${endpoint.method} Data via the ${endpoint.description} endpoint

This notebook is intended to provide some basic ideas for getting data from the iNaturalist API, in a plaform that (hopefully) is relatively easy to use and offers a lot of options for customizations. This isn't really intended to walk you through how to get data from scratch, but hopefully there's enough stuff here to inspire and help you to make something interesting and useful for yourself.

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":521,"value":"md`---\n### Input Parameters`","pinned":false,"hidden":false,"mode":"ojs"},{"id":519,"value":"html`

Input your parameter string in the field below, and then click the Get Results button. (Expand for more info.)

See API documentation for a list of available parameters.

Example Parameters:

\n \n \n ${exampleParams.map(p=>``)}\n

Parameter String	Description
`+p.string+`	`+p.description+`

In the \"more options\" section, you can also input a JWT, which will allow you to make authenticated requests to get, say, private coordinates. There is also a dropdown selection field which will allow you to return up to ${maxRecs.total} records at a time.

`","pinned":false,"hidden":false,"mode":"ojs"},{"id":112,"value":"viewof input = formWithSubmit(html``)","pinned":false,"hidden":false,"mode":"ojs"},{"id":294,"value":"md`---\n### Basic Results`","pinned":false,"hidden":false,"mode":"ojs"},{"id":506,"value":"md`|Summary Item|Value|\n|---|---|\n|API Request URL|${endpoint.reqURL}|\n|Total Records|${apiResponse.total_results}|\n|${(input.multiPage==='true')?'Pages Retrieved':'Page'}|${apiResponse.page}|\n|Records Per Page Limit|${apiResponse.per_page}|\n|Records Retrieved${(input.multiPage==='true')?' (Limit='+maxRecs.total+')':''}|${apiResponse.results?apiResponse.results.length:undefined}|`","pinned":false,"hidden":false,"mode":"ojs"},{"id":62,"value":"$31","pinned":false,"hidden":false,"mode":"ojs"},{"id":501,"value":"md`--- \n### Formatted Results`","pinned":false,"hidden":false,"mode":"ojs"},{"id":560,"value":"viewof resultsTable = table(\n apiResponse.results.map(obs=>({ // For each observation, get the data that we want to display\n 'Photo': html`${(!obs.photos||obs.photos.length===0)?'🖼️':\n '

'}`,\n 'Taxon Name': html`${!obs.taxon?'':\n ''+obs.taxon.name+''}`,\n 'Common Name': html`${!obs.taxon?'':obs.taxon.preferred_common_name||''}`,\n Grade: obs.quality_grade,\n Observer: html`${!obs.user?'':\n ''+obs.user.login+''}`,\n 'Submit Date': obs.created_at.replace('T',' '),\n 'Observed Date': obs.time_observed_at?obs.time_observed_at.replace('T',' '):obs.observed_on_string||'',\n })),\n { // table options\n title: 'iNaturalist Observations',\n pageSize: 15,\n }\n)","pinned":false,"hidden":false,"mode":"ojs"},{"id":396,"value":"md`---\n### More Information\n* [Recommended practices](https://www.inaturalist.org/pages/api+recommended+practices)\n* Node.js API v1 [documentation](https://api.inaturalist.org/v1/docs/) (current)\n* Node.js API v2 [documentation](https://api.inaturalist.org/v2/docs/) (in development as of Jan 2021)\n* Ruby API [documentation](https://www.inaturalist.org/pages/api+reference) (deprecated)\n* API Github [Repo](https://github.com/inaturalist/iNaturalistAPI)\n* [Forum](https://forum.inaturalist.org/)\n`","pinned":false,"hidden":false,"mode":"ojs"},{"id":165,"value":"md`-----\n### Configurations & Dependencies`","pinned":false,"hidden":false,"mode":"ojs"},{"id":11,"value":"endpoint = ({\n description:'v1 Observations Search',\n method:'GET',\n baseURL:'https://api.inaturalist.org/v1/observations',\n docURL:'https://api.inaturalist.org/v1/docs/#!/Observations/get_observations',\n})","pinned":true,"hidden":false,"mode":"ojs"},{"id":246,"value":"// iNaturalist will return no more than 10000 records for a set of requests with the same base parameters.\n// Most endpoints will return a maximum of 200 records per page, though this limit may vary by endpoint.\nmaxRecs = ({total:10000, perPage:200})","pinned":true,"hidden":false,"mode":"ojs"},{"id":256,"value":"// Target a 1 sec (1000 ms) delay between requests, to remain below iNaturalist's API request limits.\n// For more info, see API Recommended Practices\napiRequestDelay = 1000","pinned":true,"hidden":false,"mode":"ojs"},{"id":282,"value":"// These are example parameter strings.\n// You could also save your own set of strings here for easy future reference.\nexampleParams = [\n {string:'user_id=kueda,loarie&taxon_id=3',description:'birds observed by @kueda or @loarie'},\n {string:'taxon_id=47157&term_id=1&term_value_id=6',description:'Lepidopteran larvae (caterpillars)'},\n {string:'threatened=true&field:Eating=',description:'threatened organisms eating things'},\n {string:'d1=2020-01-01&d2=2020-03-31&sounds=true',description:'observations with sounds from Q1 2020'},\n {string:'not_in_place=6,11&place_id=1&iconic_taxa=Actinopterygii',description:'ray-finned fish in the US excl. HI/AK'},\n {string:'lat=37.423056&lng=141.033056&radius=50',description:'obs within 50km of Fukushima Daiichi'},\n]","pinned":true,"hidden":false,"mode":"ojs"},{"id":102,"value":"// Normally, actions would be triggered with each keystroke in a standard input box.\n// This provides a way for the entire set of parameters to be typed in before taking any action.\n// An alternative to using an input box like this would be to just set the string as a cell value.\nimport {formWithSubmit} from \"@forresto/form-input-with-submit\"","pinned":true,"hidden":false,"mode":"ojs"},{"id":555,"value":"// used for displaying data in a table\nimport {table} from \"@tmcw/tables/2\"","pinned":true,"hidden":false,"mode":"ojs"}],"files":"$W32","stdlib":"1","titling":"auto"}