series

Get series list

GET

https://odkmedia.io

/odx/api/v4/series/

Retrieve a paginated list of published series with optional filtering and ordering.

Get series list › query Parameters

category

string

Filter by category slug

kids

boolean

Kids profile. When true, only all-ages titles are returned: the resolved age rating (content -> season -> series) must be Vietnam 'P' or unset. Every other rating, 'K' included, is filtered out. Series and seasons are omitted when none of their episodes is all-ages. The Kids-Profile: true header does the same thing.

order

string · enum

Order results

Enum values:

newest

popularity

page

integer

A page number within the paginated result set.

Default: 1

page_size

integer

Number of results to return per page.

Example: 10

search

string

Search in title and synopsis

Get series list › Responses

PaginatedAmasianSeriesListList

count

integer

next

string | null · uri

previous

string | null · uri

AmasianSeriesList[]

GET/odx/api/v4/series/

curl https://odkmedia.io/odx/api/v4/series

Example Responses

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "data": {
        "info": {
          "dubbing_mode": true,
          "genres": [
            {
              "id": 1,
              "name": "Action"
            },
            {
              "id": 2,
              "name": "Adventure"
            },
            {
              "id": 3,
              "name": "Drama"
            }
          ],
          "season_ids": [
            1,
            2,
            3
          ],
          "series_id": 1,
          "series_slug": "example-series"
        },
        "view": {
          "badge": {
            "bottom_left": null,
            "bottom_right": null,
            "top_left": "dub",
            "top_right": null
          },
          "badges": {
            "bottom_left": null,
            "bottom_right": null,
            "top_left": "dub",
            "top_right": null
          },
          "image": {
            "language": "en",
            "orientation": "landscape",
            "url": "https://example.com/series-image.jpg"
          },
          "title": "Example Series"
        }
      },
      "type": "type"
    }
  ]
}

json

application/json

Get series detail

GET

https://odkmedia.io

/odx/api/v4/series/{slug}/

Retrieve detailed information of a series by returning the latest season's details.

Get series detail › path Parameters

slug

string · required

Series slug identifier

Example: the-genius-paik

Get series detail › query Parameters

kids

boolean

Get series detail › Responses

AmasianSeasonDetail

slug

string · maxLength: 256 · pattern: ^[-\w]+$ · required

age_rating_info

object | null · readOnly

AmasianCast[] · readOnly

AmasianCategory[] · readOnly

continue_watching_info

object | null · readOnly

Continue watching information with status and playback target

Example: {"button_text":"Watch Now","cw_updated":null,"display_text":"Episode 1","episode":{"duration":3600,"episode_order":1,"id":100,"slug":"episode-1"},"last_position":0,"progress_percentage":0,"status":"not_started"}

direct_play_content_id

string · readOnly

direct_play_content_slug

string · readOnly

dubbing_mode

string · readOnly

AmasianGenre[] · readOnly

i18n_seo_keyword

i18n_seo_synopsis

i18n_seo_title

id

integer · readOnly

is_favorite

boolean · readOnly

Check if the season is in user's favorites Args: obj: AmasianSeason instance Returns: bool: True if season is in favorites, False otherwise

poster

string · readOnly

AmasianSeasonPoster[] · readOnly

publish_end

string | null · date-time

publish_start

string | null · date-time

release_date_end

string | null · date-time

release_date_start

string | null · date-time

release_year

string · readOnly

season_order

integer | null · min: 0 · max: 2147483647

seasons

string · readOnly

seo_keyword

string | null

seo_synopsis

string | null

seo_title

string | null · maxLength: 255

object · readOnly

subtitles

string · readOnly

synopsis

string · readOnly

AmasianTag[] · readOnly

title

string · readOnly

total_number_of_seasons

string · readOnly

types_of_contents

string · readOnly

GET/odx/api/v4/series/{slug}/

curl https://odkmedia.io/odx/api/v4/series/:slug

Example Responses

{
  "age_rating": "All",
  "age_rating_info": {
    "code": "VN_T16",
    "label": "T16",
    "warnings": [
      {
        "code": "code",
        "label": "label"
      }
    ]
  },
  "cast": [
    {
      "id": 0,
      "name": "name",
      "slug": "slug",
      "thumbnail": "thumbnail"
    }
  ],
  "categories": [
    {
      "description": "description",
      "i18n_description": {},
      "i18n_title": {},
      "id": 0,
      "slug": "slug",
      "title": "title"
    }
  ],
  "continue_watching_info": {
    "button_text": "Watch Now",
    "cw_updated": null,
    "display_text": "Episode 1",
    "episode": {
      "duration": 3600,
      "episode_order": 1,
      "id": 100,
      "slug": "episode-1"
    },
    "last_position": 0,
    "progress_percentage": 0,
    "status": "not_started"
  },
  "direct_play_content_id": "direct_play_content_id",
  "direct_play_content_slug": "direct_play_content_slug",
  "dubbing_mode": "dubbing_mode",
  "genres": [
    {
      "created": "2024-08-25T15:00:00Z",
      "i18n_name": {},
      "id": 0,
      "modified": "2024-08-25T15:00:00Z",
      "name": "name",
      "slug": "slug"
    }
  ],
  "i18n_seo_keyword": {},
  "i18n_seo_synopsis": {},
  "i18n_seo_title": {},
  "id": 0,
  "is_favorite": true,
  "poster": "poster",
  "posters": [
    {
      "id": 0,
      "is_representative": true,
      "language": "ko",
      "orientation": "landscape",
      "url": "https://www.example.com/path/to/resource"
    }
  ],
  "publish_end": "2024-08-25T15:00:00Z",
  "publish_start": "2024-08-25T15:00:00Z",
  "release_date_end": "2024-08-25T15:00:00Z",
  "release_date_start": "2024-08-25T15:00:00Z",
  "release_year": "release_year",
  "season_order": 0,
  "seasons": "seasons",
  "seo_keyword": "seo_keyword",
  "seo_synopsis": "seo_synopsis",
  "seo_title": "seo_title",
  "series": {
    "id": 0,
    "slug": "slug",
    "title": "title"
  },
  "slug": "slug",
  "subtitles": "subtitles",
  "synopsis": "synopsis",
  "tags": [
    {
      "description": "description",
      "i18n_description": {},
      "i18n_title": {},
      "id": 0,
      "slug": "slug",
      "title": "title"
    }
  ],
  "title": "title",
  "total_number_of_seasons": "total_number_of_seasons",
  "types_of_contents": "types_of_contents"
}

json

application/json

season service-config

Get series list

GET

https://odkmedia.io

/odx/api/v4/series/

Retrieve a paginated list of published series with optional filtering and ordering.

Get series list › query Parameters

category

string

Filter by category slug

kids

boolean

order

string · enum

Order results

Enum values:

newest

popularity

page

integer

A page number within the paginated result set.

Default: 1

page_size

integer

Number of results to return per page.

Example: 10

search

string

Search in title and synopsis

Get series list › Responses

PaginatedAmasianSeriesListList

count

integer

next

string | null · uri

previous

string | null · uri

AmasianSeriesList[]

Get series detail

GET

https://odkmedia.io

/odx/api/v4/series/{slug}/

Retrieve detailed information of a series by returning the latest season's details.

Get series detail › path Parameters

slug

string · required

Series slug identifier

Example: the-genius-paik

Get series detail › query Parameters

kids

boolean

Get series detail › Responses

AmasianSeasonDetail

slug

string · maxLength: 256 · pattern: ^[-\w]+$ · required

age_rating_info

object | null · readOnly

AmasianCast[] · readOnly

AmasianCategory[] · readOnly

continue_watching_info

object | null · readOnly

Continue watching information with status and playback target

direct_play_content_id

string · readOnly

direct_play_content_slug

string · readOnly

dubbing_mode

string · readOnly

AmasianGenre[] · readOnly

i18n_seo_keyword

i18n_seo_synopsis

i18n_seo_title

id

integer · readOnly

is_favorite

boolean · readOnly

Check if the season is in user's favorites Args: obj: AmasianSeason instance Returns: bool: True if season is in favorites, False otherwise

poster

string · readOnly

AmasianSeasonPoster[] · readOnly

publish_end

string | null · date-time

publish_start

string | null · date-time

release_date_end

string | null · date-time

release_date_start

string | null · date-time

release_year

string · readOnly

season_order

integer | null · min: 0 · max: 2147483647

seasons

string · readOnly

seo_keyword

string | null

seo_synopsis

string | null

seo_title

string | null · maxLength: 255

object · readOnly

subtitles

string · readOnly

synopsis

string · readOnly

AmasianTag[] · readOnly

title

string · readOnly

total_number_of_seasons

string · readOnly

types_of_contents

string · readOnly