https://github.com/kylestev/ge-tracker-api
https://github.com/kylestev/ge-tracker-api
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/kylestev/ge-tracker-api
- Owner: kylestev
- License: mit
- Created: 2018-02-14T15:16:52.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-17T23:35:00.000Z (about 7 years ago)
- Last Synced: 2025-03-22T22:39:15.836Z (about 2 months ago)
- Language: JavaScript
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badge.fury.io/js/ge-tracker-api)
# ge-tracker-api
Unofficial API client to access [ge-tracker.com](https://ge-tracker.com)'s API.
## Installation
Using NPM:
`$ npm i ge-tracker-api`
Using Yarn:
`$ yarn add ge-tracker-api`
## Usage
GE-Tracker requires a valid API key in order to consume their API endpoints.
Thus, if you wish to use this package, you must have an API key.
There are two functions exposed by this module:
`createClient(apiKey, opts = null)` and `createClientFromEnv(opts = null)`.
Calling `createClient` requires an API key to be passed in order to initialize
the underlying Axios instance with your API key for all subsequent requests.
Calling `createClientFromEnv` will attempt to find the environment variable
named `GE_TRACKER_API_KEY` and use that as the API key.
### Env Client Example
```javascript
// example.js
const { createClientFromEnv } = require('ge-tracker-api')
const client = createClientFromEnv()
client.Items.getItem(1050)
.then(item => {
console.log(`${item.name} has ${item.buyingQuantity} buy offers and is
buying for ~${item.buying}`)
})
```
How you set the environment variable will depend on your development
environment.
For bash, you can prepend the environment variable before calling a script on
your path like so:
`$ GE_TRACKER_API_KEY=ajosf...928h4tr node example.js`
Please note that prepending your API key before a command may record your
sensitive API token to your bash or shell history.
A better approach is to use something like
[dotenv](https://www.npmjs.com/package/dotenv). Take care to ensure that your
environment file used by that library is added to your `.gitignore` file 😉