@amiceli/tv-fr-api
v1.0.1
Published
Lib to use the tv-fr API based on xml-tv-fr
Readme
@amiceli/[email protected]
A TypeScript SDK client for the tv-api.miceli.click API.
Usage
First, install the SDK from npm.
npm install @amiceli/tv-fr-api --saveNext, try it out.
import {
Configuration,
ChannelsApi,
} from '@amiceli/tv-fr-api'
import type { GetChannelDetailsRequest } from '@amiceli/tv-fr-api'
const api = new ChannelsApi()
const body = {
// string | Channel UUID or xmlId
id: id_example,
// string | DD/MM/YYYY (Europe/Paris) (optional)
day: 20/05/2026,
} satisfies GetChannelDetailsRequest
try {
const data = await api.getChannelDetails(body)
console.log(data)
} catch (error) {
console.error(error)
}Documentation
API Endpoints
All URIs are relative to https://tv-api.miceli.click
| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- ChannelsApi | getChannelDetails | GET /api/channel/{id} | Get a channel with its current and daily programs ChannelsApi | getChannels | GET /api/channels | List channels ChannelsApi | getTntChannels | GET /api/channels/tnt | List TNT free channels in broadcast order ChannelsApi | searchChannels | GET /api/channels/search | Search channels by name ProgramsApi | getCurrentPrograms | GET /api/programs/now | List currently airing programs ProgramsApi | getProgram | GET /api/program/{id} | Get a program by id ProgramsApi | getProgramsByDay | GET /api/programs/{day} | List programs for a specific day SearXNGApi | syncPosters | GET /api/searxng/sync | Sync poster images from SearXNG for programs without poster StatusApi | status | GET /api/status | Health check TMDBApi | handleNewPrograms | GET /api/tmdb/init | Initialize TMDB details for all programs TMDBApi | syncProgramScores | GET /api/tmdb/sync | Sync TMDB scores for current programs XmlTvApi | startJob | GET /api/xml-tv/run | Start cront to download new xml and update database
Models
- ChannelDetailsResponse
- ChannelSummary
- ChannelWithCurrent
- ChannelWithCurrentAndUrls
- PaginatedChannelsResponse
- PaginatedProgramsResponse
- ProgramDetails
- ProgramSummary
- ProgramWithChannel
- StatusResponse
Authorization
Endpoints do not require authorization.
About
This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:
- API version:
1.0 - Package version:
1.0.1 - Generator version:
7.24.0-SNAPSHOT - Build package:
org.openapitools.codegen.languages.TypeScriptFetchClientCodegen
The generated npm module supports the following:
- Environments
- Node.js
- Webpack
- Browserify
- Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
- Module systems
- CommonJS
- ES6 module system
