Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 1.6 KB

Download_API_example.md

File metadata and controls

46 lines (30 loc) · 1.6 KB
Raw

iDigBio Download API

iDigBio has four API's:

  1. Search API.
    -accessed through the ridigbio R package
    -query under 100,000
  2. Download API
    - allows query over 100,000
  3. Record API
    - used for returning raw data for a single record
  4. Media APIs
    - used for returning raw data for a media record

Example of Download API query

Full text

Here I search for Mrs, Ms, and Miss in fulltext. Change the [email protected] to your email address. This can be copy and pasted into your web browser.

https://api.idigbio.org/v2/download/?rq={"data":{"type":"fulltext","value":{"Mrs","Ms","Miss"}}}&email={[email protected]}

Note: Searching the two letters of "Ms" will yield way too many records

How to format a query to match the portal

To learn how to format the query, you can inspect a query from the web portal and view the Request Payload.

image

image

Downloading all the plant specimen

Change the [email protected] to your email address. This can be copy and pasted into your web browser.
This will take about 24 - 48 hours.

https://api.idigbio.org/v2/download/?rq={"kingdom":["Plantae"]}&email={[email protected]}