Skip to content

Consuming with the API

Erin Braswell edited this page Mar 20, 2015 · 5 revisions

Note: The current SHARE API endpoint is currently under heavy development. Check back here for more updates as we approach the public beta release.

Soon, you'll be able to query the json feed using any valid Lucene query syntax. You can query by any field in the metadata schema, by date ranges (using solr date formats), by keywords, or any combination of the above.

Here are some examples of valid queries:

  • [?q=open AND science AND source:scitech](https://osf.io/api/v1/share?q=open AND science AND source:scitech)

  • ?q=tags:frogs

  • [?q=dateUpdated:[2014-10-01 TO 2014-10-10]](https://.osf.io/api/v1/share?q=dateUpdated:[2014-10-01T00:00:00Z TO 2014-10-10T00:00:59Z])

Even more flexibility is available via the elasticsearch query dsl, see more on our page about consuming the NS with curl.

Access the raw elasticsearch results by adding the keyword raw=True

SHARE Logo

Technical Overview

Creating a Harvester

Running Harvesters with ScrAPI

Consuming Notifications - Feed Options

Issues & Using the Issue Tracker

Metadata Schema

Glossary

Provider Names

Statistics Snapshot

Experimental Push API

Use Cases

SHARE is a project of the ARL, AAU, and APLU. Development of the SHARE Notification Service is being carried out in partnership with the Center for Open Science and is supported by generous funding from The Institute of Museum and Library Services (IMLS) and the Alfred P. Sloan Foundation.

Clone this wiki locally