API Docs - arm-server (2.1.0)

Download OpenAPI specification:Download

URL: https://github.com/BeeeQueue/arm-server License: AGPL-3.0-only

A service for mapping Anime IDs.

Important:

Every endpoint returns null and not 404 when it does not find any match based on a query.

v2

v2 adds more Sources thanks to Fribb/anime-lists.

Unfortunately IMDB, TheMovieDB, and TheTVDB use one entry per show instead of season meaning their IDs become one-to-many mappings.

This means it cannot be queried for in /api/v2/ids since it's impossible for the API to look the same in that case.

Instead I added /api/v2/imdb, /api/v2/themoviedb, and /api/v2/thetvdb if you want to query by their IDs.

Fetch IDs via query parameters

Authorizations:
None
query Parameters
source
required
string
Enum: "anilist" "anidb" "anime-planet" "anisearch" "kitsu" "livechart" "notify-moe" "myanimelist"
Example: source=anilist
required
integer or string
Example: id=1337
include
string
Example: include=anilist,anidb

Comma-separated list of sources to return in response objects.

Responses

Response samples

Content type
application/json
{
  • "anidb": 1337,
  • "anilist": 1337,
  • "anime-planet": "spriggan",
  • "anisearch": null,
  • "imdb": "tt0164917",
  • "kitsu": null,
  • "livechart": null,
  • "notify-moe": "-cQb5Fmmg",
  • "themoviedb": null,
  • "thetvdb": null,
  • "myanimelist": null
}

Fetch IDs via a JSON body

The JSON body can either be an object containing the query, or an array containing multiple queries.

If using array queries, the resulting array will map to the corresponding input!

e.g. body[1] will be the result of query[1].

Authorizations:
None
query Parameters
include
string
Example: include=anilist,anidb

Comma-separated list of sources to return in response objects.

Request Body schema: application/json
required
One of
non-empty
null or integer
null or integer
null or string
null or integer
null or integer
null or integer
null or string
null or integer

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "anidb": 1337,
  • "anilist": 1337,
  • "anime-planet": "spriggan",
  • "anisearch": null,
  • "imdb": "tt0164917",
  • "kitsu": null,
  • "livechart": null,
  • "notify-moe": "-cQb5Fmmg",
  • "themoviedb": null,
  • "thetvdb": null,
  • "myanimelist": null
}

Fetch IDs by IMDB ID

Authorizations:
None
query Parameters
id
required
integer >= 1
Example: id=tt5370118
include
string
Example: include=anilist,anidb

Comma-separated list of sources to return in response objects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetch IDs by TheMovieDB ID

Authorizations:
None
query Parameters
id
required
integer >= 1
Example: id=1337
include
string
Example: include=anilist,anidb

Comma-separated list of sources to return in response objects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetch IDs by TheTVDB ID

Authorizations:
None
query Parameters
id
required
integer >= 1
Example: id=1337
include
string
Example: include=anilist,anidb

Comma-separated list of sources to return in response objects.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

v1

Fetch IDs via query parameters

Authorizations:
None
query Parameters
source
required
string
Enum: "anidb" "anilist" "kitsu" "myanimelist"
Example: source=anilist
id
required
integer >= 1
Example: id=1337

Responses

Response samples

Content type
application/json
{
  • "anidb": 1337,
  • "anilist": 1337,
  • "kitsu": null,
  • "myanimelist": null
}

Fetch IDs via a JSON body

The JSON body can either be an object containing the query, or an array containing multiple queries.

If using array queries, the resulting array will map to the corresponding input!

e.g. body[1] will be the result of query[1].

Authorizations:
None
Request Body schema: application/json
required
One of
null or integer
null or integer
null or integer
null or integer

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "anidb": 1337,
  • "anilist": 1337,
  • "kitsu": null,
  • "myanimelist": null
}