Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/content/data-use-policy.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# NEON Data Use and Citation Policy

For more information on NEON Data Use and Citation Policy visit our
[About Data Policies](https://www.neonscience.org/data-samples/data-policies-citation)
page.
For more information on NEON Data Use and Citation Policies visit our
[Data Guidelines and Policies](https://www.neonscience.org/data-samples/guidelines-policies) page.

<br />
35 changes: 19 additions & 16 deletions docs/content/index.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,26 @@
# Welcome to the NEON Data API
# NEON Data API

## **Introduction**

The NEON Data API (Application Programming Interface) can be used to quickly access data as well as information about our data products, samples, and sampling locations. This API provides a simple means of constructing URLs or cURL statements that return information in a common machine-readable format, [JSON (JavaScript Object Notation)](https://json.org/json-en.html).

The NEON Data API (Application Programming Interface) can be used to quickly access data as well as information about NEON's data products, samples, and sampling locations. It provides a simple means of constructing URLs or cURL statements that return information in a common machine-readable format, [JSON (JavaScript Object Notation)](https://json.org/json-en.html).

## **R & Python packages**
The neonUtilities packages are the easiest way to download and reformat NEON data.
* [`neonUtilities` R package](https://cran.r-project.org/web/packages/neonUtilities/index.html)
* [`neonutilities` Python package](https://pypi.org/project/neonutilities)
* Check out the ["Use the neonUtilities Package to Access NEON Data" tutorial](https://www.neonscience.org/resources/learning-hub/tutorials/neondatastackr)

## **REST API Explorer**
The API provides numerous endpoints, some of which provide the option to enter values for specific parameters that allow you to refine your search. To learn more about each endpoint, click on “REST API Endpoints” in the navigation menu. To try each endpoint out, open the [REST API Explorer](https://data.neonscience.org/data-api/explorer/).

In addition to providing REST API endpoints, the NEON Data API also provides a [GraphQL](https://data.neonscience.org/data-api/graphql/) endpoint, allowing users to take advantage of the flexibility and efficiency of the [GraphQL data query language](https://graphql.org/) to access NEON metadata. The `/graphql` endpoint affords users the ability to define and receive only desired metadata.

If you need more information, try visiting our

* [GitHub repository](https://github.com/NEONScience/neon-data-api),
* [Using the NEON API tutorial](https://www.neonscience.org/neon-api-usage), or
* [FAQ](https://www.neonscience.org/faq).

We also provide an [R package](https://cran.r-project.org/web/packages/neonUtilities/index.html), called `neonUtilities`, that you can use to download and reformat the data.

## **Feedback**
## **GraphQL**
The [GraphQL](https://data.neonscience.org/data-api/graphql/) endpoint allows users to take advantage of the flexibility and efficiency of the [GraphQL data query language](https://graphql.org/) to access NEON metadata. The `/graphql` endpoint affords users the ability to define and receive only desired metadata.

**Tell us what you think**: If you have design ideas, functionality requests, bug notes, examples of how you used the API, or anything else you would like us to know, please [file an issue](https://github.com/NEONScience/neon-data-api/issues) and tell us about it!
## **Other Resources**
* [The NEON Data API GitHub repository](https://github.com/NEONScience/neon-data-api),
* [Using the NEON API tutorial](https://www.neonscience.org/neon-api-usage)
* Download the [Swagger documentation](https://raw.githubusercontent.com/NEONScience/neon-data-api/refs/heads/main/packages/docs-app-swagger/src/swagger.json)

## **Provide Feedback**
If you have design ideas, functionality requests, bug notes, examples of how you used the API, etc., please [contact us](https://www.neonscience.org/about/contact-us).

<br />
12 changes: 6 additions & 6 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,20 +44,20 @@ extra_css:
# Nav items
nav:
- Home: 'https://www.neonscience.org'
- Data Portal: 'https://www.neonscience.org/data'
- Data Portal: 'https://data.neonscience.org/data-products/explore'
- NEON Data API:
- 'About': index.md
- 'REST API':
- 'REST API Explorer & Endpoints':
- 'REST API Explorer': 'explorer/index.md'
- 'Products': 'endpoints/products.md'
- 'Sites': 'endpoints/sites.md'
- 'Releases': 'endpoints/releases.md'
- 'Locations': 'endpoints/locations.md'
- 'Data': 'endpoints/data.md'
- 'Data Query': 'endpoints/data-query.md'
- 'Locations': 'endpoints/locations.md'
- 'Taxonomy': 'endpoints/taxonomy.md'
- 'Releases': 'endpoints/releases.md'
- 'Samples': 'endpoints/samples.md'
- 'Taxonomy': 'endpoints/taxonomy.md'
- 'Prototype Datasets': 'endpoints/prototype-datasets.md'
- 'REST API Explorer': 'explorer/index.md'
- 'GraphQL API':
- 'Overview': 'graphql/index.md'
- 'GraphQL Explorer': 'graphql/explorer/index.md'
Expand Down
Loading