Skip to content

updated README file with changes requested from PM/Support #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kchatzikok merged 2 commits into from
Apr 6, 2022
Merged

updated README file with changes requested from PM/Support #18

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0fb9795
updated README file
argyris-gardelakos Apr 1, 2022
0cea97f
added bold note
argyris-gardelakos Apr 1, 2022
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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,3 +216,11 @@ To run the tests, set the `VARSOME_API_KEY` environment variable to your API tok
tests will fail because the API will return a 401 (not authenticated) error.
Be advised as well that running the tests will count towards your account request limit depending on the
API package you are subscribed to.

### Staging-api environment

The staging-api.varsome.com environment is a free usage test environment for subscribers. It is the perfect environment for evaluating the performance of the API. It is updated on an adhoc basis at our discretion, either together with live or possibly ahead of live in order to test upcoming new features.

It contains a substantial, but partial, data-set. Additionally it is throttled and is limited in the types of queries you can run. For example, it allows for only a limited number of samples and a limited size of data.

**Please note: For this reason API queries performed against the staging environment within the client may not always run correctly or may produce different results to the production environment.**