> For the complete documentation index, see [llms.txt](https://sharix.gitbook.io/sharix-tv-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sharix.gitbook.io/sharix-tv-api/reference/shows.md).

# Shows

## All

All shows can be requested.

## Get all shows

<mark style="color:blue;">`GET`</mark> `https://api.sharix.tech/shows`

Returns an array of all available shows.

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| api-key<mark style="color:red;">\*</mark>     | string  | `[api-key]` |
| api-version<mark style="color:red;">\*</mark> | integer | `1`         |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## Random

A random show can be requested.

## Get a random show

<mark style="color:blue;">`GET`</mark> `https://api.sharix.tech/random/show`

Returns details of a random show.

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| api-key<mark style="color:red;">\*</mark>     | string  | `[api-key]` |
| api-version<mark style="color:red;">\*</mark> | integer | `1`         |

{% tabs %}
{% tab title="200: OK " %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}

## Page

Shows can be requested from a specific page.

## Get shows by page

<mark style="color:blue;">`GET`</mark> `https://api.sharix.tech/shows/:page`

Returns shows of the selected page.

#### Path Parameters

| Name | Type    | Description                                    |
| ---- | ------- | ---------------------------------------------- |
| page | integer | The page of the content you want. `Example: 1` |

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| api-key<mark style="color:red;">\*</mark>     | string  | `[api-key]` |
| api-version<mark style="color:red;">\*</mark> | integer | `1`         |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## Sort

Shows can be sorted according to the following criteria:

* Trending `trending`
* Popular `popular`
* Released `released`
* Last added `last added`
* Top rated `rating`
* Year of publication `year`
* Name A-Z `name`

## Get shows by sort criteria

<mark style="color:blue;">`GET`</mark> `https://api.sharix.tech/shows/:page?sort=:parameter`

Returns an array of shows that correspond to the selected sort criteria.

#### Path Parameters

| Name | Type    | Description                                    |
| ---- | ------- | ---------------------------------------------- |
| page | integer | The page of the content you want. `Example: 1` |

#### Query Parameters

| Name | Type   | Description                                   |
| ---- | ------ | --------------------------------------------- |
| sort | string | Sort the list of content. `Example: trending` |

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| api-key<mark style="color:red;">\*</mark>     | string  | `[api-key]` |
| api-version<mark style="color:red;">\*</mark> | integer | `1`         |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## Order

Shows can be orderd according to the following options:

* Upwards `1`
* Downwards `-1`

## Get shows by order

<mark style="color:blue;">`GET`</mark> `https://api.sharix.tech/shows/:page?order=:parameter`

Returns an orderd list of shows that correspond to the order

#### Path Parameters

| Name | Type    | Description                                    |
| ---- | ------- | ---------------------------------------------- |
| page | integer | The page of the content you want. `Example: 1` |

#### Query Parameters

| Name  | Type    | Description                              |
| ----- | ------- | ---------------------------------------- |
| order | integer | Order the list of content. `Example: -1` |

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| api-key<mark style="color:red;">\*</mark>     | string  | `[api-key]` |
| api-version<mark style="color:red;">\*</mark> | integer | `1`         |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## Genre

Shows can be requested according to the following genres:

* Adventure `adventure`
* Action `action`
* Animation `animation`
* Documentation `documentation`
* Drama `drama`
* Family `family`
* Fantasy `fantasy`
* Comedy `comedy`
* Horror `horror`
* Crime `crime`
* Music `music`
* Mystery `mystery`
* Romantic `romantic`
* Science Fiction `science-fiction`
* Thriller `thriller`
* Western `western`

## Get shows by genre

<mark style="color:blue;">`GET`</mark> `https://api.sharix.tech/shows:page?genre=:parameter`

Returns an array of showsS that correspond to the selected genre.

#### Path Parameters

| Name | Type    | Description                                    |
| ---- | ------- | ---------------------------------------------- |
| page | integer | The page of the content you want. `Example: 1` |

#### Query Parameters

| Name  | Type   | Description                             |
| ----- | ------ | --------------------------------------- |
| genre | string | Filter on a genre. `Example: adventure` |

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| api-key<mark style="color:red;">\*</mark>     | string  | `[api-key]` |
| api-version<mark style="color:red;">\*</mark> | integer | `1`         |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## Search

Shows can be requested according to specific search keywords.

## Get shows by keyword

<mark style="color:blue;">`GET`</mark> `https://api.sharix.tech/shows/:page?keywords=:parameter`

Returns an array of shows that correspond to the search keyword.

#### Path Parameters

| Name | Type    | Description                                    |
| ---- | ------- | ---------------------------------------------- |
| page | integer | The page of the content you want. `Example: 1` |

#### Query Parameters

| Name     | Type   | Description                                    |
| -------- | ------ | ---------------------------------------------- |
| keywords | string | Search based on keywords. `Example: Star Wars` |

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| api-key<mark style="color:red;">\*</mark>     | string  | `[api-key]` |
| api-version<mark style="color:red;">\*</mark> | integer | `1`         |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## Languages

Shows can be requested according to the following languages:

* English `en`
* Spanish `es`
* Italian `it`
* French `fr`
* German `de`
* Dutch `nl`
* Russian `ru`

## Get shows by language

<mark style="color:blue;">`GET`</mark> `https://api.sharix.tech/shows/page?local=:parameter&content-locale=:parameter`

Returns an array of showsS that correspond to the selected language.

#### Path Parameters

| Name | Type    | Description                                    |
| ---- | ------- | ---------------------------------------------- |
| page | integer | The page of the content you want. `Example: 1` |

#### Query Parameters

| Name           | Type   | Description                         |
| -------------- | ------ | ----------------------------------- |
| locale         | string | Filter on a language. `Example: en` |
| content-locale | string | Filter on a language. `Example: en` |

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| api-key<mark style="color:red;">\*</mark>     | string  | `[api-key]` |
| api-version<mark style="color:red;">\*</mark> | integer | `1`         |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## Multiple parameters

Shows can be requested according to multiple parameters. The following parameters are available:

* Page `{page}`
* Sort `{sort}`
* Order `{order}`
* Genre `{genre}`
* Search `{keywords}`
* Language `{locale}` `{content-locale}`

## Get shows by multiple parameters

<mark style="color:blue;">`GET`</mark> `https://api.sharix.tech/shows/:page?sort=:parameter&order=:parameter`

Returns an array of shows that correspond to the parameters.

#### Path Parameters

| Name | Type    | Description                                    |
| ---- | ------- | ---------------------------------------------- |
| page | integer | The page of the content you want. `Example: 1` |

#### Query Parameters

| Name           | Type    | Description                                    |
| -------------- | ------- | ---------------------------------------------- |
| sort           | string  | Sort the list of content. `Example: trending`  |
| order          | integer | Order the list of the content: `Example: -1`   |
| genre          | string  | Filter on a genre. `Example: adventure`        |
| keywords       | string  | Search based on keywords. `Example: Star Wars` |
| locale         | string  | Filter on a language. `Example: en`            |
| content-locale | string  | Filter on a language. `Example: en`            |

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| api-key<mark style="color:red;">\*</mark>     | string  | `[api-key]` |
| api-version<mark style="color:red;">\*</mark> | integer | `1`         |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}

## Details

Details about a show can be requested using the IMDb ID

## Get show details

<mark style="color:blue;">`GET`</mark> `https://api.sharix.tech/shows/:imdb-id`

Returns details about a single show based on the given IMDb ID.

#### Path Parameters

| Name    | Type   | Description                                                                              |
| ------- | ------ | ---------------------------------------------------------------------------------------- |
| imdb-id | string | <p>The IMDb ID of the movie you want details on. <br><code>Example: tt0468569</code></p> |

#### Headers

| Name                                          | Type    | Description |
| --------------------------------------------- | ------- | ----------- |
| api-key<mark style="color:red;">\*</mark>     | string  | `[api-key]` |
| api-version<mark style="color:red;">\*</mark> | integer | `1`         |

{% tabs %}
{% tab title="200 " %}

```
```

{% endtab %}
{% endtabs %}