connectedpapers-js
Advanced tools
Comparing version
{ | ||
"name": "connectedpapers-js", | ||
"version": "0.1.3", | ||
"version": "0.1.4", | ||
"description": "The official client for the connected papers API", | ||
@@ -5,0 +5,0 @@ "main": "dist/index.js", |
@@ -45,3 +45,3 @@ # connectedpapers-js | ||
# Supplying an API key | ||
## Supplying an API key | ||
There are two ways to supply an API key to the client: | ||
@@ -65,2 +65,13 @@ * Set the `CONNECTED_PAPERS_API_KEY` environment variable. | ||
You can use the API key `TEST_TOKEN` to access the graph of | ||
the paper with ID `9397e7acd062245d37350f5c05faf56e9cfae0d6` for | ||
testing purposes. | ||
## Paper IDs | ||
We use ShaIDs by [Semantic Scholar](https://www.semanticscholar.org/) as paper IDs. | ||
You can find the ShaID of a paper by going to its Semantic Scholar page and | ||
copying the ID from the URL. For example, the ShaID of the paper | ||
[DeepFruits: A Fruit Detection System Using Deep Neural Networks](https://www.semanticscholar.org/paper/DeepFruits%3A-A-Fruit-Detection-System-Using-Deep-Bargoti-Underwood/9397e7acd062245d37350f5c05faf56e9cfae0d6) | ||
is `9397e7acd062245d37350f5c05faf56e9cfae0d6`. | ||
## Async iterator access | ||
@@ -67,0 +78,0 @@ The client also supports async iterator access to the API. This is useful for |
44863
1.46%123
9.82%