OSDR Biological Data API Release

I am excited to share with you that we released the OSDR Biological Data API earlier this week:

It is a successor to GLOpenAPI that now incorporates both GeneLab and ALSDA datasets from the OSDR data repo (hence the rebranding) and improves access to their metadata and data.

The classic use cases are all there:

  • you can select and retrieve sample-level metadata across the entire database with compound queries and filters,
  • and then request the matching underlying data.

To that, we added:

  • a REST interface (making it easier to traverse the database and find dataset, assay, sample, and file objects);
  • retrieval of more deeply nested metadata fields;
  • additional sensible output formats;
  • and we significantly improved the API’s performance, too.

Also, while it’s primarily intended for programmatic access, interactive in-browser
viewers for JSONs and tables are back and better than ever.

Check it out and let us know what you think!

Here’s some examples:

P.S. The legacy GLOpenAPI is currently still operational in its original location, so none of your existing scripts will break: https://visualization.genelab.nasa.gov/GLOpenAPI/.
That said, the new Biological Data API has a layer that makes it backwards compatible with GLOpenAPI (just replace https://visualization.genelab.nasa.gov/GLOpenAPI/ with https://visualization.osdr.nasa.gov/biodata/api/ – no “v2”); we encourage people to try it out, or even better, to start transitioning to the new API and the new syntax that is described in the documentation.

@HUMANawg @MultiOmicsAWG @AnimalAWG @AIMLawg @ALSDAawg @PlantAWG @MicrobesAWG @RLWG @FemaleReproAWG

14 Likes

For those of you attending the AWG Catalyst Summit, we will dedicate time to discussing the new API in more detail! Looking forward to seeing you there!

Also, we would like to hear your feedback and create an FAQ section in our docs based on common use cases.

Finally, in recognizing that the current documentation is rather terse, I put together a fairly informal Jupyter notebook with hands-on examples that shed light on the thinking behind the API design.
I would really appreciate you all giving it a go and letting me know how it went:

Thanks all!

6 Likes

Great news :top_arrow:

3 Likes

Thanks @kirill !

Looking forward to your lightning talk on Wednesday, followed by that dedicated breakout on Wednesday, led by @lauren.sanders to cover all things on how to use the new API

CHEERS!

4 Likes

This is SO cool and useful @kirill, thanks for sharing!

4 Likes