Difference between revisions of "IDigBio Download API"

From iDigBio
Jump to: navigation, search
(Created page with "Note: While the download API is currently used by the production portal, it should be considered highly unstable for non-iDigBio consumers. The next revision of the API will m...")
 
Line 2: Line 2:
  
 
=== Main Download Endpoint ===
 
=== Main Download Endpoint ===
https://csv.idigbio.org/?query=&lt;idigbio query format as documented by search api, although not all query types are available yet>&email=<email, optional>
+
https://csv.idigbio.org/?query=&lt;[https://github.com/iDigBio/idigbio-search-api/wiki/Query-Format idigbio query format] , not all query types are available yet>&email=<email, optional>
  
 
Ex. https://csv.idigbio.org/?query={%22genus%22:%22acer%22}
 
Ex. https://csv.idigbio.org/?query={%22genus%22:%22acer%22}

Revision as of 10:43, 27 April 2015

Note: While the download API is currently used by the production portal, it should be considered highly unstable for non-iDigBio consumers. The next revision of the API will most likely be a total rewrite, backend and front.

Main Download Endpoint

https://csv.idigbio.org/?query=<idigbio query format , not all query types are available yet>&email=<email, optional>

Ex. https://csv.idigbio.org/?query={%22genus%22:%22acer%22}


Status Endpoint

http://csv.idigbio.org/status/<download id> (returned as "status_url" from the original download query)

Ex.

http://csv.idigbio.org/status/995ed58b-01fd-4c98-893e-e0cbdfadc8fe