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
3 changes: 1 addition & 2 deletions docs/content/data-use-policy.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# NEON Data Use and Citation Policy

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.
NEON data products and sample data are licensed under a Creative Commons Attribution 4.0 International License ([CC-BY](https://creativecommons.org/licenses/by/4.0/)). For more information, visit the [Data Guidelines and Policies](https://www.neonscience.org/data-samples/guidelines-policies) page.

<br />
9 changes: 9 additions & 0 deletions docs/content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,15 @@
## **Introduction**
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).

## **Authentication**
You do not need to authenticate in order to explore information about NEON data or locations. However, if you will be using the APIs to download data products or sample data, or using the APIs intensively, then you will need to sign up for and use an [API Token](https://www.neonscience.org/resources/learning-hub/tutorials/api-token-setup). The endpoints this currently applies to are:

- /data (including /data/query and /releases/data)
- /samples

## **Data Use Policy and Licensing**
NEON data products and sample data are licensed under a Creative Commons Attribution 4.0 International License ([CC-BY](https://creativecommons.org/licenses/by/4.0/)). For more information, visit the [Data Guidelines and Policies](https://www.neonscience.org/data-samples/guidelines-policies) page.

## **R & Python packages**
The neonUtilities packages are the easiest way to download and reformat NEON data.

Expand Down
23 changes: 16 additions & 7 deletions docs/content/rate-limiting.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
# Rate Limiting

To ensure the quality of NEON's data API and associated services,
the data APIs are subject to rate limiting. Limits are applied and tracked globally
across all endpoints. You do not need to authenticate in order to explore NEON data. However, if you
will be intensively using the APIs, then you should sign up for an [API Token](#api-tokens).
To ensure the quality of NEON's data API and associated services, API
endpoints are subject to rate limiting. Limits are applied and tracked
globally across all endpoints.

You do not need to authenticate in order to explore information about NEON
data or locations. However, if you will be using the APIs to download data
products or sample data, or using the APIs intensively, then you will need
to sign up for and use an
[API Token](https://www.neonscience.org/resources/learning-hub/tutorials/api-token-setup).
The endpoints this currently applies to are:

- /data (including /data/query and /releases/data)
- /samples

!!! info
NEON reserves the right to modify the rate limits at any time.
Expand All @@ -12,8 +21,8 @@ will be intensively using the APIs, then you should sign up for an [API Token](#

All limits consist of two factors:

- A burst - the total number of requests that can be made in a short period of time
independent of rate, and
- A burst - the total number of requests that can be made in a short period
of time independent of rate, and
- a rate - the number of requests per second that can be made

Once the burst amount is utilized in its entirety, you will still be able to make
Expand Down Expand Up @@ -163,7 +172,7 @@ a per token basis with the following rate specification for the token's `rate` s

|Scope|Burst|Rate|Identifier|
|---|---|---|---|
|`rate:public`|1000 requests|4 requests per second|Token|
|`rate:public`|2000 requests|8 requests per second|Token|


<br/>