Skip to content
/ sdk Public

JavaScript library to query data from iptv-org/api

License

iptv-org/sdk

Repository files navigation

SDK

JavaScript library to query data from iptv-org/api.

Installation

npm install @iptv-org/sdk

Quick Start

import sdk from '@iptv-org/sdk'

const client = new sdk.Client()

await client.load()

const data = client.getData()

console.log(data.streams.all())

Results:

[
  {
    "channel": null,
    "feed": null,
    "title": "Iman TV",
    "url": "https://live.relentlessinnovations.net:1936/imantv/imantv/playlist.m3u8",
    "referrer": null,
    "user_agent": null,
    "quality": "480p"
  }
  //...
]

Usage

Get entities

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, which makes it easy to filter and sort items:

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:

const channels = countries.first().getChannels()

console.log(channels)

A complete list of available methods can be found in the documentation.

Search channels

import sdk from '@iptv-org/sdk'

const client = new sdk.Client()

await client.load()

const results = client.searchChannels('cat')

console.log(results)

Testing

npm test

Contribution

If you find a bug or want to contribute to the code or documentation, you can help by submitting an issue or a pull request.

And thank you to everyone who has already contributed!

Backers

Contributors

License

CC0

About

JavaScript library to query data from iptv-org/api

Resources

License

Code of conduct

Stars

Watchers

Forks