nasa / nasa/api-docs

Please update API queries & links for NASA Exoplanet Archive section

Open
#250 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
SCSS
Stars
555
Forks
140
Avg merge
2h 30m
Merged PRs (30d)
3

Description

Hello,

The links and API queries for the NASA Exoplanet Archive need to be updated on the api.nasa.gov page. The archive has migrated almost all of its data tables to use the Table Access Protocol (TAP), which changes the base URL of API queries.

Here is the suggested updated text and links:

Introduction

The Exoplanet Archive API allows programmatic access to NASA's Exoplanet Archive database. This API contains a ton of options, so to get started, please visit this page for introductory materials. To see what data is available in this API visit here, and also be sure to check out best-practices and troubleshooting in case you get stuck. Happy planet hunting!


Example Queries

Example API | URL

Confirmed planets in the Kepler field https://exoplanetarchive.ipac.caltech.edu/TAP/sync?query=select+*+from+ps+where+default_flag+=+1+and+disc_facility+LIKE+%27Kepler%27+order+by+pl_name+asc&format=votable)

Confirmed planets that transit their host stars https://exoplanetarchive.ipac.caltech.edu/TAP/sync?query=select+*+from+ps+where+tran_flag=1+and+default_flag=1+order+by+pl_name&format=tsv)

All Kepler planetary candidates smaller than 2Re with equilibrium temperatures between 180-303K] (https://exoplanetarchive.ipac.caltech.edu/TAP/sync?query=select+*+from+cumulative+where+koi_prad<2+and+koi_teq>180+and+koi_teq<303+and+koi_disposition+like+'CANDIDATE'&format=ipac)

More examples here.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the api.nasa.gov page's NASA Exoplanet Archive section and compare its current text and links with the suggested TAP-based content in this issue. Update the introduction and example queries, then verify that the archive links and query URLs match the requested TAP endpoints and examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
sql
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.