# API docs & params explained

**URL:** <https://forum.inaturalist.org/t/api-docs-params-explained/42673>\
**Category:** General\
**Created:** [June 19, 2023, 8:03pm UTC](https://forum.inaturalist.org/t/api-docs-params-explained/42673 "2023-06-19T20:03:03Z")\
**Posts on this page:** 7\
**Page:** 1

<div class="post-metadata">

**Author:** ![elantrybuch](https://sea2.discourse-cdn.com/flex016/user_avatar/forum.inaturalist.org/elantrybuch/32/37491_2.png) [@elantrybuch](https://forum.inaturalist.org/u/elantrybuch)\
**Post date:** [June 19, 2023, 8:03pm UTC](https://forum.inaturalist.org/t/api-docs-params-explained/42673/1 "2023-06-19T20:03:04Z")

</div>

Hello, I am wanting to make my own iNat widget based of the API docs, I am seeing 2:

- [v1](https://api.inaturalist.org/v1)
- [v2](https://api.inaturalist.org/v2)

I am wanting to know, which I can’t find on the docs, what params are available. I am wanting to grab observations for a specific project ID, as well as limit the results and define the size of the image I want.

Thanks!

---

<div class="post-metadata">

**Author:** ![jwidness](https://avatars.discourse-cdn.com/v4/letter/j/9d8465/32.png) [@jwidness](https://forum.inaturalist.org/u/jwidness)\
**Post date:** [June 19, 2023, 8:12pm UTC](https://forum.inaturalist.org/t/api-docs-params-explained/42673/2 "2023-06-19T20:12:32Z")

</div>

If you scroll down and expand, the params are documented on that page:

 ![image](https://us1.discourse-cdn.com/flex016/uploads/inaturalist/original/3X/6/d/6db03e503736bd40052ba4f6026f59ebccad0ff8.png)

---

<div class="post-metadata">

**Author:** ![elantrybuch](https://sea2.discourse-cdn.com/flex016/user_avatar/forum.inaturalist.org/elantrybuch/32/37491_2.png) [@elantrybuch](https://forum.inaturalist.org/u/elantrybuch)\
**Post date:** [June 19, 2023, 8:29pm UTC](https://forum.inaturalist.org/t/api-docs-params-explained/42673/3 "2023-06-19T20:29:16Z")

</div>

Thank you for your reply, but I am not seeing all the documentation for all available params on there.

For example:  
This returns 200  
[https://api.inaturalist.org/v2/observations?project\_id=17548](https://api.inaturalist.org/v2/observations?project_id=17548)

I do not see `project_id` listed as a valid param on [v1](https://api.inaturalist.org/v1/docs/#!/Observations/get_observations_id) I do see `project_ids`

On [v2](https://api.inaturalist.org/v2/docs/#/Observations/get_observations) I do see `project_id` but that only accepts an `array` where as my 200 url I posted is a `string`/`number`

Are the swagger docs just out dated? Is there a comprehensive list for the API that shows all the param each method can take? And what about defining the size of the photo.

---

<div class="post-metadata">

**Author:** ![jtklein](https://sea2.discourse-cdn.com/flex016/user_avatar/forum.inaturalist.org/jtklein/32/249_2.png) [@jtklein](https://forum.inaturalist.org/u/jtklein)\
**Post date:** [June 19, 2023, 8:50pm UTC](https://forum.inaturalist.org/t/api-docs-params-explained/42673/4 "2023-06-19T20:50:53Z")

</div>

Hello,  
Both v1 and v2 /observations have a param “project\_id” that takes an array as input. In your request you also specified an array, just with one element. E.g., this [https://api.inaturalist.org/v2/observations?project\_id=17548,17549](https://api.inaturalist.org/v2/observations?project_id=17548,17549) has two elements and therefore more total results.

---

<div class="post-metadata">

**Author:** ![pisum](https://avatars.discourse-cdn.com/v4/letter/p/91b2a8/32.png) [@pisum](https://forum.inaturalist.org/u/pisum)\
**Post date:** [June 19, 2023, 10:04pm UTC](https://forum.inaturalist.org/t/api-docs-params-explained/42673/5 "2023-06-19T22:04:33Z")

</div>

> [@elantrybuch](#):
>
> I do not see `project_id` listed as a valid param on [v1](https://api.inaturalist.org/v1/docs/#!/Observations/get_observations_id) I do see `project_ids`

it seems like you might be confusing two different routes / endpoints and their model responses vs their parameters:

- `https://api.inaturalist.org/v1/observations/{id}`
- `https://api.inaturalist.org/v1/observations`

it’s the second one above that accepts a `project_id` parameter, not the first.

---

<div class="post-metadata">

**Author:** ![elantrybuch](https://sea2.discourse-cdn.com/flex016/user_avatar/forum.inaturalist.org/elantrybuch/32/37491_2.png) [@elantrybuch](https://forum.inaturalist.org/u/elantrybuch)\
**Post date:** [June 22, 2023, 7:20pm UTC](https://forum.inaturalist.org/t/api-docs-params-explained/42673/6 "2023-06-22T19:20:04Z")

</div>

Thanks, I was able to re-create the iNat project thumbnails and make my own widget.

its not perfect, but does what I need:

 ![Screen Shot 2023-06-22 at 15.11.34](https://us1.discourse-cdn.com/flex016/uploads/inaturalist/original/3X/0/0/009c03ccbd0df0828cec78364839e7b0aba862e1.jpeg)

Here is a link to my pen: [https://codepen.io/elaniobro/pen/oNQzKZd](https://codepen.io/elaniobro/pen/oNQzKZd)

---

<div class="post-metadata">

**Author:** ![system](https://us1.discourse-cdn.com/flex016/uploads/inaturalist/original/2X/7/7831452cf7f0d653ff1ffd34176334b7ef1b6a17.png) [@system](https://forum.inaturalist.org/u/system)\
**Post date:** [August 21, 2023, 7:20pm UTC](https://forum.inaturalist.org/t/api-docs-params-explained/42673/7 "2023-08-21T19:20:18Z")

</div>

This topic was automatically closed 60 days after the last reply. New replies are no longer allowed.
