Database

All data is stored in the /data folder as CSV (Comma-separated values) files. Any of the files can be edited either with a basic text editor or through any spreadsheet editor (such as Google Sheets, LibreOffice, ...).

Data Scheme

channels
categories
countries
languages
regions
subdivisions
blocklist

channels

Field	Description	Required	Example
id	Unique channel ID. Should be derived from the name of the channel and country code separated by dot. May only contain Latin letters, numbers and dot.	Required	`AnhuiTV.cn`
name	Official channel name in English. May include: `a-z`, `à-ÿ`, `0-9`, `space`, `-`, `!`, `:`, `&`, `.`, `+`, `'`, `/`, `»`, `#`, `%`, `°`, `$`, `@`, `?`, `(`, `)`.	Required	`Anhui TV`
native_name	Channel name in the original language. May contain any characters except `,` and `"`.	Optional	`安徽卫视`
network	Network of which this channel is a part.	Optional	`Anhui`
country	Country code from which the channel is transmitted. A list of all supported countries and their codes can be found in data/countries.csv	Required	`CN`
subdivision	Code of the subdivision (e.g., provinces or states) from which the broadcast is transmitted. A list of all supported subdivisions and their codes can be found in data/subdivisions.csv	Optional	`CN-AH`
city	Name of the city from which the channel is transmitted. May only contain `a-z`, `à-ÿ`, `0-9`, `space`, `-`, `'`.	Optional	`Hefei`
broadcast_area	List of codes describing the broadcasting area of the channel. Any combination of `r/<region_code>`, `c/<country_code>`, `s/<subdivision_code>`	Required	`s/CN-AH`
languages	List of languages in which the channel is broadcast separated by `;`. A list of all supported languages and their codes can be found in data/languages.csv	Required	`zho`
categories	List of categories to which this channel belongs separated by `;`. A list of all supported categories can be found in data/categories.csv	Optional	`general`
is_nsfw	Indicates whether the channel broadcasts adult content (`TRUE` or `FALSE`)	Required	`FALSE`
launched	Launch date of the channel (`YYYY-MM-DD`)	Optional	`2016-07-28`
closed	Date on which the channel closed (`YYYY-MM-DD`)	Optional	`2020-05-31`
replaced_by	The ID of the channel that this channel was replaced by.	Optional	`CCTV1.cn`
website	Official website URL.	Optional	`http://www.ahtv.cn/`
logo	Logo URL. Only URL with HTTPS protocol are allowed. Supported image types: `PNG`, `JPEG`.	Required	`https://example.com/logo.png`

Field	Description	Required	Example
id	Category ID. Should be the same as the name but in lower case.	Required	`news`
name	Category name in one word.	Required	`News`

languages

Field	Description	Required	Example
name	Official language name	Required	`Croatian`
code	ISO 639-3 code of the language	Required	`hrv`

countries

Field	Description	Required	Example
name	Official name of the country	Required	`Martinique`
code	ISO 3166-1 alpha-2 code of the country	Required	`MQ`
lang	Official language in the country.	Required	`fra`
flag	Country flag emoji	Required	`🇲🇶`

subdivisions

Field	Description	Required	Example
country	Country code of the division.	Required	`CA`
name	Official subdivision name	Required	`British Columbia`
code	ISO 3166-2 code of the subdivision	Required	`CA-BC`

regions

Field	Description	Required	Example
name	Official name of the region.	Required	`Central Asia`
code	Abbreviated designation for the region. May only contain Latin letters in upper case. The minimum length is 3 letters.	Required	`CAS`
countries	List of country codes in the region.	Required	`KG;KZ;TJ;TM;UZ`

blocklist

List of channels blocked at the request of copyright holders.

Field	Description	Required	Example
channel	Channel ID	Required	`AnimalPlanetAfrica.us`
ref	Link to removal request or DMCA takedown notice	Required	`https://example.com/issues/0000`

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.

9.4 KiB Raw Blame History