https://github.com/iptv-org/sdk
JavaScript library to query data from iptv-org/api
https://github.com/iptv-org/sdk
Last synced: 4 months ago
JSON representation
JavaScript library to query data from iptv-org/api
- Host: GitHub
- URL: https://github.com/iptv-org/sdk
- Owner: iptv-org
- License: unlicense
- Created: 2025-09-27T14:15:13.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2026-04-11T22:54:34.000Z (4 months ago)
- Last Synced: 2026-04-12T00:33:03.602Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 559 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# SDK [](https://github.com/iptv-org/sdk/actions/workflows/publish.yml)
JavaScript library to query data from [iptv-org/api](https://github.com/iptv-org/api).
## Installation
```sh
npm install @iptv-org/sdk
```
## Quick Start
```js
import sdk from '@iptv-org/sdk'
const client = new sdk.Client()
await client.load()
const data = client.getData()
console.log(data.streams.all())
```
Results:
```jsonc
[
{
"channel": null,
"feed": null,
"title": "Iman TV",
"url": "https://live.relentlessinnovations.net:1936/imantv/imantv/playlist.m3u8",
"referrer": null,
"user_agent": null,
"quality": "480p",
"label": "Geo-blocked"
}
//...
]
```
## Usage
### Get entities
```js
import sdk from '@iptv-org/sdk'
const client = new sdk.Client()
await client.load()
const data = client.getData()
const {
channels,
feeds,
logos,
streams,
guides,
categories,
languages,
countries,
subdivisions,
cities,
regions,
timezones,
blocklist
} = data
```
All data is contained in the helper class [Collection](https://github.com/freearhey/core-js/blob/master/docs/classes/Collection.md), which makes it easy to filter and sort items:
```js
const filtered = channels
.filter(channel => channel.country === 'FR')
.sortBy(channel => channel.name)
.all()
console.log(filtered)
```
Each element of the collection also has a set of useful methods:
```js
const channels = countries.first().getChannels()
console.log(channels)
```
A complete list of available methods can be found in the [documentation](docs/@iptv-org/namespaces/Models/README.md).
### Search channels
```js
import sdk from '@iptv-org/sdk'
const client = new sdk.Client()
await client.load()
const results = client.searchChannels('cat')
console.log(results)
```
## Testing
```sh
npm test
```
## Contribution
If you find a bug or want to contribute to the code or documentation, you can help by submitting an [issue](https://github.com/iptv-org/api/issues) or a [pull request](https://github.com/iptv-org/api/pulls).
And thank you to everyone who has already contributed!
### Backers
### Contributors
## License
[](LICENSE)