Skip to content

Latest commit

 

History

History
153 lines (90 loc) · 3.63 KB

episode.mdx

File metadata and controls

153 lines (90 loc) · 3.63 KB
sidebar_position
2

Episode

import ApiCodeBlock from '../../src/components/ApiCodeBlock'; import Highlight from '../../src/components/Highlight'; import ApiTryIt from '../../src/components/ApiTryIt';

export const endpoints = [ { method: 'GET', uri: '/v1/episode/:id' }, { method: 'GET', uri: '/v1/episode' }, ];

This is an object representing an Anime show's Episode. The API allows you to retrieve individual Episode as well as a list of them using various filters.

The Episode object

Attributes

id

Unique identifier for an Episode.

anime_id

Anime external unique identifier.

number

The episode's progressive number referring to the entire show.

title

The episode's localized title.

video

The episode's streaming url.

source

The episode's website from which it has been imported.

locale

The episode's website related locale.

Example

{
  "anime_id": 11,
  "number": 1,
  "title": "Il ragazzo di gomma",
  "video": "https://api.aniapi.com/v1/proxy/https%3a%2f%2fcdn2.dr...",
  "source": "dreamsub",
  "locale": "it",
  "id": 485
}

Retrieve a specific Episode

Retrieves an Episode, based on its unique identifier.

Parameters

No parameters.

Returns

Returns an Episode object if a valid identifier was provided.

Try it

export const retrieveEpisodeParams = [ { name: ':id', type: 'number', placeholder: ':id', value: '485' } ];

Get a list of Episode

Returns a list of Episode object. The Episodes are returned sorted by anime_id and number.

Parameters

anime_id

A filter on the list based on the anime_id field value.

number

A filter on the list based on the number field value.

source

A case-sensitive pattern filter on the list based on the source field value.

locale

A case-sensitive pattern filter on the list based on the locale field value.

Returns

Returns an array of Episode objects with a size based on the filter provided.

Try it

export const getListEpisodeParams = [ { name: 'anime_id', type: 'number', placeholder: 'anime_id', value: '11' }, { name: 'number', type: 'number', placeholder: 'number', value: '' }, { name: 'source', type: 'text', placeholder: 'source', value: 'dreamsub' }, { name: 'locale', type: 'text', placeholder: 'locale', value: 'it' } ];