作品とキャラクター、そのキャラクターを演じた人物の組み合わせを取得するエンドポイントです。
リクエストの送り方やページネーションについてはREST API V1の概要をご参照ください。
GET /v1/casts
Annictに登録されているキャスト情報を取得することができます。
フィールド
| 名前 | 概要 |
|---|---|
| id | ID |
| name | 名前 |
| name_en | 名前 (英語表記) |
| sort_number | ソート番号 |
| work | 紐づく作品情報。取得できるフィールドはREST API V1の作品と同じです。 |
| character | 紐づくキャラクター情報。REST API V1のキャラクターのフィールドが入りますが、series は入りません。 |
| person | 紐づく人物情報。REST API V1の人物のフィールドが入りますが、prefecture は入りません。 |
パラメータ
| 名前 | 概要 | 使用例 |
|---|---|---|
| fields | レスポンスボディに含まれるデータのフィールドを絞り込みます。 | fields=id,name |
| filter_ids | IDで絞り込みます。 | filter_ids=1,2,3 |
| filter_work_id | 作品IDで絞り込みます。 | filter_work_id=1111 |
| page | ページ数を指定します。 | page=2 |
| per_page | 1ページに何件取得するかを指定します。デフォルトは 25 件で、50 件まで指定できます。 |
per_page=30 |
| sort_id | IDで並び替えます。asc または desc が指定できます。 |
sort_id=desc |
| sort_sort_number | ソート用の番号で並び替えます。asc または desc が指定できます。 |
sort_sort_number=desc |
リクエスト例
キャストは作品・キャラクター・人物の3つを入れ子で返すため、レスポンスが大きくなります。
必要なフィールドが決まっている場合は fields で絞り込むと扱いやすくなります。
$ curl -X GET "https://api.annict.com/v1/casts?access_token=(access_token)&filter_ids=43414&fields=id,name,name_en,sort_number,work.id,work.title,character.id,character.name,person.id,person.name"
{
"casts": [
{
"id": 43414,
"name": "東山奈央",
"name_en": "Touyama, Nao",
"sort_number": 10,
"work": {
"id": 5459,
"title": "ゆるキャン△"
},
"character": {
"id": 32268,
"name": "志摩リン"
},
"person": {
"id": 1411,
"name": "東山奈央"
}
}
],
"total_count": 1,
"next_page": null,
"prev_page": null
}
fields を指定しない場合は、work ・ character ・ person のフィールドがすべて入ります。