Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jharrilim/balldontlie-client
Javascript client for retrieving NBA stats with the balldontlie API.
https://github.com/jharrilim/balldontlie-client
api async ball basketball client dont generator javascript lie nba stats
Last synced: 4 days ago
JSON representation
Javascript client for retrieving NBA stats with the balldontlie API.
- Host: GitHub
- URL: https://github.com/jharrilim/balldontlie-client
- Owner: jharrilim
- License: gpl-3.0
- Created: 2019-06-09T19:09:23.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T23:45:57.000Z (almost 2 years ago)
- Last Synced: 2024-12-14T00:37:04.308Z (21 days ago)
- Topics: api, async, ball, basketball, client, dont, generator, javascript, lie, nba, stats
- Language: TypeScript
- Homepage: https://jharrilim.github.io/balldontlie-client
- Size: 995 KB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# balldontlie-client
[![Build Status]](https://dev.azure.com/josephharrisonlim/josephharrisonlim/_build/latest?definitionId=2&branchName=master)
[![NPM Badge]](https://www.npmjs.com/package/@jharrilim/balldontlie-client)
[![NPM Downloads]](https://www.npmjs.com/package/@jharrilim/balldontlie-client)
Javascript client for [Balldontlie](https://github.com/ynnadkrap/balldontlie).
API Docs for this client can be found [here](https://jharrilim.github.io/balldontlie-client/classes/_api_v1_index_.v1client.html).
## API Implementation Status
| API | Status |
| -------------------------------------------------------------: | :----- |
| [Players](https://www.balldontlie.io/#players) | ✅ |
| [Teams](https://www.balldontlie.io/#teams) | ✅ |
| [Games](https://www.balldontlie.io/#games) | ✅ |
| [Stats](https://www.balldontlie.io/#stats) | ✅ |
| [Season Averages](https://www.balldontlie.io/#season-averages) | ✅ |
## Install
```sh
npm i @jharrilim/balldontlie-client
```
## Usage
This library uses async generators for handling pagination. You may use this in conjunction with
[for-await-of](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of)
to make multiple API requests. You may also request for one page at a time by awaiting `.next()`.
Axios is used interally, and axios configuration options may be passed into `.v1()` if needed.
> Warning: This API is rate limited. You may only make up to [60 requests per minute](http://www.balldontlie.io/#getting-started).
### Example with for-await-of
```js
import { BallDontLie } from '@jharrilim/balldontlie-client';
void async function main() {
const v1Client = BallDontLie.v1();
for await(const teams of v1Client.teams(0)) {
// paginate through all the teams
for(const team of teams) {
console.log(team.full_name);
}
}
}().catch(console.error);
```
### Example with .next()
```js
import { BallDontLie } from '@jharrilim/balldontlie-client';
void async function main() {
const v1Client = BallDontLie.v1();
const teamGenerator = v1Client.teams(0, 10); // starting from 0, 10 per page
const teams1 = (await teamGenerator.next()).value; // get the first 10 teams
teams1.forEach(team => console.log(team.full_name));
const teams2 = (await teamGenerator.next()).value; // get the next 10 teams after the first 10
teams2.forEach(team => console.log(team.full_name));
}().catch(console.error);
```
More examples can be found in the [tests](./test/integration/api.test.ts).
[Build Status]: https://dev.azure.com/josephharrisonlim/josephharrisonlim/_apis/build/status/jharrilim.balldontlie-client?branchName=master
[NPM Badge]: https://img.shields.io/npm/v/@jharrilim/balldontlie-client.svg
[NPM Downloads]: https://img.shields.io/npm/dt/@jharrilim/balldontlie-client.svg