# Annict Docs


# Languages

* [Japanese](/docs/ja)
* [English](/docs/en)


# Annict Docs (日本語)

Annictの開発に関するドキュメントをまとめています。GraphQL APIについては [developers.annict.jp](https://developers.annict.jp/) をご参照ください。

## ドキュメントの編集について

このドキュメントは、GitHubのリポジトリ [annict/docs](https://github.com/annict/docs) で管理しているMarkdownファイルを、[GitBook](https://www.gitbook.com)を利用してHTMLに変換し表示しています。

もしドキュメントに不備等ありましたら、[Issue](https://github.com/annict/docs/issues)や[Pull Request](https://github.com/annict/docs/pulls)で教えて頂けると幸いです。


# api


# v1


# GET /v1/users

Annictに登録されているユーザ情報を取得することができます。

## フィールド

| 名前                     | 概要                   |
| ---------------------- | -------------------- |
| id                     | ユーザID                |
| username               | URLなどで使用されているユーザ名    |
| name                   | ユーザの名前               |
| description            | プロフィール               |
| url                    | ユーザのURL              |
| avatar\_url            | アバター画像               |
| background\_image\_url | 背景画像                 |
| records\_count         | 記録数                  |
| followings\_count      | ユーザがフォローしている人の数      |
| followers\_count       | ユーザをフォローしている人の数      |
| wanna\_watch\_count    | ステータスを「見たい」にしている作品の数 |
| watching\_count        | ステータスを「見てる」にしている作品の数 |
| watched\_count         | ステータスを「見た」にしている作品の数  |
| on\_hold\_count        | ステータスを「中断」にしている作品の数  |
| stop\_watching\_count  | ステータスを「中止」にしている作品の数  |
| created\_at            | ユーザ登録した日時            |

## パラメータ

| 名前                | 概要                                                | 使用例                                   |
| ----------------- | ------------------------------------------------- | ------------------------------------- |
| fields            | レスポンスボディに含まれるデータのフィールドを絞り込みます。                    | fields=id,username                    |
| filter\_ids       | ユーザをIDで絞り込みます。                                    | filter\_ids=1,2,3                     |
| filter\_usernames | ユーザをユーザ名で絞り込みます。                                  | filter\_usernames=shimbaco,datekoichi |
| page              | ページ数を指定します。                                       | page=2                                |
| per\_page         | 1ページに何件取得するかを指定します。デフォルトは `25` 件で、`50` 件まで指定できます。 | per\_page=30                          |
| sort\_id          | ユーザをIDで並び替えます。`asc` または `desc` が指定できます。           | sort\_id=desc                         |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/users?access_token=(access_token)&filter_usernames=shimbaco
```

```javascript
{
  "users": [
    {
      "id": 2,
      "username": "shimbaco",
      "name": "Koji Shimba",
      "description": "アニメ好きが高じてこのサービスを作りました。聖地巡礼を年に数回しています。",
      "url": "http://shimba.co",
      "avatar_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_avatars/master/d8af7adc8122c96ba7639218fd8b5ede332d42f2.jpg?1431357292",
      "background_image_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_background_images/master/ee15d577fb2f2d61bdaf700cfab894b286a5762d.jpg?1486753229",
      "records_count": 2369,
      "followings_count": 258,
      "followers_count": 205,
      "wanna_watch_count": 237,
      "watching_count": 103,
      "watched_count": 335,
      "on_hold_count": 45,
      "stop_watching_count": 244,
      "created_at": "2014-03-02T15:38:40.000Z"
    }
  ],
  "total_count": 1,
  "next_page": null,
  "prev_page": null
}
```


# overview

## ベースURI

Annict APIのベースURIは下記になります。

```
https://api.annict.com
```

Annictが提供する全てのAPIには、このベースURIの後にエンドポイントのパスを記述してアクセスすることができます。例えば作品情報を取得する場合は、パス `/v1/works` を繋げて下記のようにリクエストを送ります。

```
GET https://api.annict.com/v1/works
```

## 日付

フォーマットは[ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) (`YYYY-MM-DDTHH:MM:SSZ`) で返します。よってタイムゾーンはUTCとなります。

## 認可 / 認証方法

Annict APIではリソースへの認可や認証にOAuth 2.0を使用しています。OAuth 2.0については [RFC 6749](https://tools.ietf.org/html/rfc6749) をご覧ください。

## アクセストークンの付与

Annict APIを通じてリソースを取得するためには、OAuthプロバイダ (Annict) が発行したアクセストークンをリクエストに付与する必要があります。付与の仕方は2種類あります。

1. リクエストヘッダに付与する
2. URIのパラメータに付与する

### リクエスト例 (リクエストヘッダに付与する)

```
$ curl -H "Authorization: Bearer 35372b2d866222ed33e355c36d86be498076e037a810ee72963819339c781f32" \
-X GET https://api.annict.com/v1/works
```

### リクエスト例 (URIのパラメータに付与する)

```
$ curl -X GET https://api.annict.com/v1/works?access_token=35372b2d866222ed33e355c36d86be498076e037a810ee72963819339c781f32
```

### レスポンス例

```javascript
{
  "works": [
    {
      "id":1129,
      "title":"精霊の守り人",
      "title_kana":"せいれいのもりびと",
      "media":"tv",
      ...
    }
  ]
}
```

アクセストークンの取得方法は [認証](/docs/ja/api/v1/authentication) ページに記載しています。

## HTTPステータスコード

Annict APIでは下記の条件でHTTPステータスコードを返します。

| ステータスコード                    | 条件                                                                           |
| --------------------------- | ---------------------------------------------------------------------------- |
| 200 (OK)                    | リクエストが成功し、同時に処理が正常に完了したとき。                                                   |
| 201 (Created)               | リクエストが成功し、新しいリソースが作られたとき。                                                    |
| 202 (Accepted)              | リクエストは成功したが、処理は非同期で実行されるとき。                                                  |
| 204 (No Content)            | リクエストが成功し、レスポンスボディが存在しないとき。`DELETE` メソッドでリソースが削除されたときに使用します。                 |
| 400 (Bad Request)           | リクエストの内容が正しくないとき。                                                            |
| 401 (Unauthorized)          | リソースへのアクセスに認証が必要なとき。リクエストを送ったクライアントが特定できないときに使用します。                          |
| 403 (Forbidden)             | リソースへのアクセスが禁止されているとき。リクエストを送ったクライアントは特定したものの、指定されたリソースへのアクセスを禁止しているときに使用します。 |
| 404 (Not Found)             | 指定されたリソースが存在しないとき。                                                           |
| 500 (Internal Server Error) | Annictのサーバ内部に問題があり正常にレスポンスが返せないとき。                                           |
| 503 (Service Unavailable)   | Annictのサーバが一時的に停止しているとき。                                                     |

## ページネーション

作品一覧など、複数のリソースを返すAPIにはページを指定して取得するリソースを分割するようになっています。ページを指定する場合は `page` パラメータを、1ページあたり何件のリソースを取得するかを指定する場合は `per_page` パラメータを使用します。デフォルト値などの情報は各エンドポイントのドキュメントに記載しています。

レスポンスデータには `total_count`, `next_page`, `prev_page` の3つのフィールドが付加されます。`total_count` にはページを跨いだ全リソース数、`next_page`, `prev_page` には次のページ数、前のページ数が格納されています。次のページ、前のページが存在しない場合は `null` が格納されます。 以下は全8件の作品情報の4ページ目を2件取得する例です。5ページ目は存在しないため、`next_page` が `null` になっています。

```
GET https://api.annict.com/v1/works?per_page=2&page=4&access_token=(access_token)
```

```javascript
{
  "works": [
    ...
  ],
  "total_count": 8,
  "next_page": null,
  "prev_page": 3
}
```

## エラー

Annict APIがエラーを返すときは、基本的に以下の形式でレスポンスボディを返します。

```javascript
"errors": [{
  "type": "invalid_params",
  "message": "リクエストに失敗しました",
  "developer_message": "per_pageは1以上の値にしてください",
  "url": "http://example.com/docs/api/validations"
}]
```

| キー名                | 概要                               |
| ------------------ | -------------------------------- |
| type               | 発生したエラーのタイプ。全てのタイプは下記の表にまとめています。 |
| message            | アプリケーションの利用者向けのエラーメッセージ。         |
| developer\_message | APIを利用している開発者向けのエラーメッセージ。        |

| type            | 概要                     |
| --------------- | ---------------------- |
| invalid\_params | リクエスト時に渡したパラメータに不備がある。 |


# GET /v1/episodes

Annictに登録されているエピソード情報を取得することができます。

## フィールド

| 名前                      | 概要                                                                |
| ----------------------- | ----------------------------------------------------------------- |
| id                      | エピソードのID                                                          |
| number                  | エピソードの話数                                                          |
| number\_text            | エピソードの話数 (表記用)                                                    |
| sort\_number            | ソート用の番号。話数でソートすると正しく並べられないケースがあるため、このフィールドが存在します。                 |
| title                   | サブタイトル                                                            |
| records\_count          | 記録数                                                               |
| record\_comments\_count | 感想付きの記録数                                                          |
| work                    | このエピソードが紐づく作品情報。取得できるフィールドは [Works](/docs/ja/api/v1/works) と同じです。 |
| prev\_episode           | このエピソードの前のエピソード情報。取得できるフィールドは同じです。                                |
| next\_episode           | このエピソードの次のエピソード情報。取得できるフィールドは同じです。                                |

## パラメータ

| 名前                 | 概要                                                | 使用例                     |
| ------------------ | ------------------------------------------------- | ----------------------- |
| fields             | レスポンスボディに含まれるデータのフィールドを絞り込みます。                    | fields=id,title         |
| 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 |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/episodes?access_token=(access_token)
```

```javascript
{
  "episodes": [
    {
      "id": 45,
      "number": null,
      "number_text": "第2話",
      "sort_number": 2,
      "title": "殺戮の夢幻迷宮",
      "records_count": 0,
      "record_comments_count": 0,
      "work": {
        "id": 3831,
        "title": "NEWドリームハンター麗夢",
        "title_kana": "",
        "media": "ova",
        "media_text": "OVA",
        "season_name": "1990-autumn",
        "season_name_text": "1990年秋",
        "released_on": "1990-12-16",
        "released_on_about": "",
        "official_site_url": "",
        "wikipedia_url": "",
        "twitter_username": "",
        "twitter_hashtag": "",
        "episodes_count": 2,
        "watchers_count": 10
      },
      "prev_episode": {
        "id": 44,
        "number": null,
        "number_text": "第1話",
        "sort_number": 1,
        "title": " 夢の騎士達",
        "records_count": 0,
        "record_comments_count": 0
      },
      "next_episode": null
    },
...
```


# authentication

Annict APIからリソースにアクセスするにはアクセストークンが必要になります。 アクセストークンは以下の2種類の方法で取得することができます。

1. 「個人用アクセストークン」を作成する
2. OAuth認証をする

## 「個人用アクセストークン」を作成する

個人用アクセストークンを作成することで、OAuth認証をせずにアクセストークンを取得することができます。 アクセストークンは「[アプリケーション](https://annict.com/settings/apps)」ページから作成することができます。

## OAuth認証をする

### クライアントアプリケーションを作成する

OAuthで使用するクライアントIDなどを保持するクライアントアプリケーションを作成します。クライアントアプリケーションは <https://annict.com/oauth/applications> から作成することができます。

### 認可のリクエストを送る

Annict APIが提供するリソースにどのような権限でアクセスするかをAnnictに伝えるため、認可のためのリクエストを送る必要があります。

#### GET /oauth/authorize

アクセス許可を求めるページが表示されます。

**パラメータ**

| 名前             | 概要                                                                                                 |
| -------------- | -------------------------------------------------------------------------------------------------- |
| client\_id     | **\[必須]** クライアントID。作成したクライアントアプリケーションのclient\_idになります。                                             |
| response\_type | **\[必須]** 認可後にコールバックで返ってきたときのURIに付与される認証コードのパラメータ名。 `code` を指定してください。                              |
| redirect\_uri  | **\[必須]** 認可後のコールバックでどのURIに返るかを指定します。`urn:ietf:wg:oauth:2.0:oob` を指定した場合、認可後にリダイレクトせず認証コードが表示されます。 |
| scope          | リソースにアクセスする際の権限を指定します。デフォルトは `read` (読み込み専用) になっています。書き込み権限も付与したい場合は `read write` を指定してください。       |

**リクエスト例**

下記の例では `redirect_uri` に `urn:ietf:wg:oauth:2.0:oob` が指定されているため、認可後のページに認証コードが表示されます。

```
GET /oauth/authorize?client_id=f96b162be2c54b467f7583a0e141d0df99bf16318146f9bf53116d82b145fde6&response_type=code&redirect_uri=urn%3Aietf%3Awg%3Aoauth%3A2.0%3Aoob&scope=read+write
```

下記の例では `redirect_uri` に `http://example.com` が指定されているため、認可後に `http://example.com/?code=xxx` というページにリダイレクトされます。パラメータ `code` に渡されている値が認証コードになります。

```
GET /oauth/authorize?client_id=f96b162be2c54b467f7583a0e141d0df99bf16318146f9bf53116d82b145fde6&response_type=code&redirect_uri=http://example.com&scope=read+write
```

### アクセストークンを取得する

認可後に取得した認証コードを使用して、アクセストークンを取得します。

#### POST /oauth/token

アクセストークンを発行します。

**パラメータ**

| 名前             | 概要                                                   |
| -------------- | ---------------------------------------------------- |
| client\_id     | **\[必須]** クライアントID。                                  |
| client\_secret | **\[必須]** 作成したクライアントアプリケーションのシークレットキー。               |
| grant\_type    | **\[必須]** `authorization_code` を指定してください。            |
| redirect\_uri  | **\[必須]** クライアントアプリケーションを作成したときに入力したコールバックURIを指定します。 |
| code           | **\[必須]** 認可後に取得した認証コードを指定します。                       |

**リクエスト例**

```
$ curl -F client_id=f96b162be2c54b467f7583a0e141d0df99bf16318146f9bf53116d82b145fde6 \
-F client_secret=9bef7fc39d5d6210ecaaa34d8ccfe5e7a10babd2ebad90876307d71a8e14de69 \
-F grant_type=authorization_code \
-F redirect_uri=http://example.com \
-F code=82c0436de2b586ca974b45ab4e12ceeeeda2a8cf90a269b2dbc5a24c4a6fc8f2 \
-X POST https://api.annict.com/oauth/token
```

**レスポンス例**

```
HTTP/1.1 200 OK
ontent-Type: application/json; charset=utf-8
```

```javascript
{
  "access_token":"58468586b6f4c29e88a8d9b7f3babb8364fec9991f2681081cbfd849d7c11a91",
  "token_type":"bearer",
  "scope":"read write",
  "created_at":1465718311
}
```

### アクセストークンの情報を取得する

#### GET /oauth/token/info

アクセストークンの情報を取得します。`Authorization` ヘッダにアクセストークンを渡してリクエストを送ります。

**リクエスト例**

```
$ curl -H "Authorization: Bearer 35372b2d866222ed33e355c36d86be498076e037a810ee72963819339c781f32" \
-X GET https://api.annict.com/oauth/token/info
```

**レスポンス例**

```
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
```

```javascript
{
  "resource_owner_id":2,
  "scopes":["read","write"],
  "expires_in_seconds":null,
  "application": {
    "uid":"bfa6272ede7f7d096099c4e5f15923a78630520435169f47006e18d5e4dc2a7e"
  },
  "created_at":1461949248
}
```

### アクセストークンを失効させる

#### POST /oauth/revoke

アクセストークンを失効させます。`Authorization` ヘッダと `token` パラメータを渡してリクエストを送ります。

**パラメータ**

| 名前             | 概要                                     |
| -------------- | -------------------------------------- |
| client\_id     | **\[必須]** クライアントID。                    |
| client\_secret | **\[必須]** 作成したクライアントアプリケーションのシークレットキー。 |
| token          | **\[必須]** アクセストークンを指定します。              |

**リクエスト例**

```
$ curl -H "Authorization: Bearer 35372b2d866222ed33e355c36d86be498076e037a810ee72963819339c781f32" \
-F client_id=f96b162be2c54b467f7583a0e141d0df99bf16318146f9bf53116d82b145fde6 \
-F client_secret=9bef7fc39d5d6210ecaaa34d8ccfe5e7a10babd2ebad90876307d71a8e14de69 \
-F token=35372b2d866222ed33e355c36d86be498076e037a810ee72963819339c781f32 \
-X POST https://api.annict.com/oauth/revoke
```

**レスポンス例**

```
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
```

```javascript
{}
```


# GET /v1/me

自分のプロフィール情報を取得することができます。

## フィールド

| 名前                     | 概要                   |
| ---------------------- | -------------------- |
| id                     | ユーザID                |
| username               | URLなどで使用されているユーザ名    |
| name                   | ユーザの名前               |
| description            | プロフィール               |
| url                    | ユーザのURL              |
| avatar\_url            | アバター画像               |
| background\_image\_url | 背景画像                 |
| records\_count         | 記録数                  |
| followings\_count      | ユーザがフォローしている人の数      |
| followers\_count       | ユーザをフォローしている人の数      |
| wanna\_watch\_count    | ステータスを「見たい」にしている作品の数 |
| watching\_count        | ステータスを「見てる」にしている作品の数 |
| watched\_count         | ステータスを「見た」にしている作品の数  |
| on\_hold\_count        | ステータスを「中断」にしている作品の数  |
| stop\_watching\_count  | ステータスを「中止」にしている作品の数  |
| created\_at            | ユーザ登録した日時            |
| email                  | ユーザのメールアドレス          |
| notifications\_count   | 通知数                  |

## パラメータ

| 名前     | 概要                             | 使用例                |
| ------ | ------------------------------ | ------------------ |
| fields | レスポンスボディに含まれるデータのフィールドを絞り込みます。 | fields=id,username |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/me?access_token=(access_token)
```

```javascript
{
  "id": 2,
  "username": "shimbaco",
  "name": "Koji Shimba",
  "description": "アニメ好きが高じてこのサービスを作りました。聖地巡礼を年に数回しています。",
  "url": "http://shimba.co",
  "avatar_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_avatars/master/d8af7adc8122c96ba7639218fd8b5ede332d42f2.jpg?1431357292",
  "background_image_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_background_images/master/ee15d577fb2f2d61bdaf700cfab894b286a5762d.jpg?1486753229",
  "records_count": 2369,
  "followings_count": 258,
  "followers_count": 205,
  "wanna_watch_count": 237,
  "watching_count": 103,
  "watched_count": 335,
  "on_hold_count": 45,
  "stop_watching_count": 244,
  "created_at": "2014-03-02T15:38:40.000Z",
  "email": "me@shimba.co",
  "notifications_count": 0
}
```


# GET /v1/series

Annictに登録されているシリーズ情報を取得することができます。

## フィールド

| 名前       | 概要          |
| -------- | ----------- |
| id       | ID          |
| name     | 名前          |
| name\_ro | 名前 (ローマ字表記) |
| name\_en | 名前 (英語表記)   |

## パラメータ

| 名前           | 概要                                                | 使用例               |
| ------------ | ------------------------------------------------- | ----------------- |
| fields       | レスポンスボディに含まれるデータのフィールドを絞り込みます。                    | fields=id,name    |
| filter\_ids  | シリーズをIDで絞り込みます。                                   | filter\_ids=1,2,3 |
| filter\_name | シリーズを名前で絞り込みます。                                   | filter\_name=株式会社 |
| page         | ページ数を指定します。                                       | page=2            |
| per\_page    | 1ページに何件取得するかを指定します。デフォルトは `25` 件で、`50` 件まで指定できます。 | per\_page=30      |
| sort\_id     | シリーズをIDで並び替えます。`asc` または `desc` が指定できます。          | sort\_id=desc     |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/series?access_token=(access_token)&filter_ids=65
```

```javascript
{
  "series": [
    {
      "id": 65,
      "name": "ソードアート・オンライン",
      "name_ro": "Sword Art Online",
      "name_en": "Sword Art Online"
    }
  ],
  "total_count": 1,
  "next_page": null,
  "prev_page": null
}
```


# GET /v1/me/programs

放送予定を取得することができます。

## フィールド

| 名前              | 概要                                                                        |
| --------------- | ------------------------------------------------------------------------- |
| id              | 放送予定ID                                                                    |
| started\_at     | 放送開始日時                                                                    |
| is\_rebroadcast | この放送予定が再放送かどうか。再放送の場合は `true` が、そうでない場合は `false` が格納されています。               |
| channel         | チャンネル情報                                                                   |
| work            | この放送予定が紐づく作品情報。取得できるフィールドは [Works](/docs/ja/api/v1/works) と同じです。          |
| episode         | この放送予定が紐づくエピソード情報。取得できるフィールドは [Episodes](/docs/ja/api/v1/episodes) と同じです。 |

## パラメータ

| 名前                      | 概要                                                                     | 使用例                                      |
| ----------------------- | ---------------------------------------------------------------------- | ---------------------------------------- |
| fields                  | レスポンスボディに含まれるデータのフィールドを絞り込みます。                                         | fields=id,episode.title                  |
| filter\_ids             | 放送予定を放送予定IDで絞り込みます。                                                    | filter\_ids=1,2,3                        |
| filter\_channel\_ids    | 放送予定をチャンネルIDで絞り込みます。                                                   | filter\_channel\_ids=1,2,3               |
| filter\_work\_ids       | 放送予定を作品IDで絞り込みます。                                                      | filter\_work\_ids=1,2,3                  |
| filter\_started\_at\_gt | 放送予定を放送開始日時で絞り込みます。指定した日時以降の放送予定が取得できます。なお、指定した日時のタイムゾーンはUTCとして解釈されます。 | filter\_started\_at\_gt=2016/05/06 21:10 |
| filter\_started\_at\_lt | 放送予定を放送開始日時で絞り込みます。指定した日時以前の放送予定が取得できます。なお、指定した日時のタイムゾーンはUTCとして解釈されます。 | filter\_started\_at\_lt=2016/05/06 21:10 |
| filter\_unwatched       | 未視聴の放送予定だけを取得します。                                                      | filter\_unwatched=true                   |
| filter\_rebroadcast     | 放送予定を再放送フラグをもとに絞り込みます。`true` を渡すと再放送だけが、`false` を渡すと再放送以外の放送予定が取得できます。 | filter\_rebroadcast=true                 |
| page                    | ページ数を指定します。                                                            | page=2                                   |
| per\_page               | 1ページに何件取得するかを指定します。デフォルトは `25` 件で、`50` 件まで指定できます。                      | per\_page=30                             |
| sort\_id                | 放送予定を放送予定IDで並び替えます。`asc` または `desc` が指定できます。                           | sort\_id=desc                            |
| sort\_started\_at       | 放送予定を放送開始日時で並び替えます。`asc` または `desc` が指定できます。                           | sort\_started\_at=desc                   |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/me/programs?sort_started_at=desc&filter_started_at_gt=2016/05/05 02:00&access_token=(access_token)
```

```javascript
{
  "programs": [
    {
      "id": 35387,
      "started_at": "2016-05-07T20:10:00.000Z",
      "is_rebroadcast": false,
      "channel": {
        "id": 4,
        "name": "日本テレビ"
      },
      "work": {
        "id": 4681,
        "title": "ふらいんぐうぃっち",
        "title_kana": "ふらいんぐうぃっち",
        "media": "tv",
        "media_text": "TV",
        "season_name": "2016-spring",
        "season_name_text": "2016年春",
        "released_on": "",
        "released_on_about": "",
        "official_site_url": "http://www.flyingwitch.jp/",
        "wikipedia_url": "https://ja.wikipedia.org/wiki/%E3%81%B5%E3%82%89%E3%81%84%E3%82%93%E3%81%90%E3%81%86%E3%81%83%E3%81%A3%E3%81%A1",
        "twitter_username": "flying_tv",
        "twitter_hashtag": "flyingwitch",
        "episodes_count": 5,
        "watchers_count": 695
      },
      "episode": {
        "id": 75187,
        "number": "5",
        "number_text": "第5話",
        "sort_number": 50,
        "title": "使い魔の活用法",
        "records_count": 0,
        "record_comments_count": 0
      }
    },
...
```


# GET /v1/records

エピソードへの記録を取得することができます。

## フィールド

| 名前              | 概要                                                                                 |
| --------------- | ---------------------------------------------------------------------------------- |
| id              | 記録ID                                                                               |
| comment         | 記録したときに書かれた感想                                                                      |
| rating          | **\[非推奨]** 記録したときに付けられたレーティング。`0` から `5` までの数値が入っています。今後は `rating_state` を参照して下さい。 |
| rating\_state   | 記録したときに付けられたレーティング。`bad` `average` `good` `great` の4種類が入っています。                     |
| is\_modified    | この記録が編集されたかどうか                                                                     |
| likes\_count    | Likeされた数                                                                           |
| comments\_count | コメントされた数                                                                           |
| created\_at     | 記録された日時                                                                            |
| user            | この記録をした利用者の情報                                                                      |
| work            | この記録が紐づく作品情報。取得できるフィールドは [Works](/docs/ja/api/v1/works) と同じです。                     |
| episode         | この記録が紐づくエピソード情報                                                                    |

## パラメータ

| 名前                           | 概要                                                                             | 使用例                               |
| ---------------------------- | ------------------------------------------------------------------------------ | --------------------------------- |
| fields                       | レスポンスボディに含まれるデータのフィールドを絞り込みます。                                                 | fields=id,title                   |
| filter\_ids                  | 記録を記録IDで絞り込みます。                                                                | filter\_ids=1,2,3                 |
| filter\_episode\_id          | 記録をエピソードIDで絞り込みます。                                                             | filter\_episode\_id=1111          |
| filter\_has\_record\_comment | 記録を感想のあるなしで絞り込みます。感想付きの記録のみに絞り込むときは `true` を、感想の無い記録のみに絞り込むときは `false` を指定します。 | filter\_has\_record\_comment=true |
| page                         | ページ数を指定します。                                                                    | page=2                            |
| per\_page                    | 1ページに何件取得するかを指定します。デフォルトは `25` 件で、`50` 件まで指定できます。                              | per\_page=30                      |
| sort\_id                     | 記録を記録IDで並び替えます。`asc` または `desc` が指定できます。                                       | sort\_id=desc                     |
| sort\_likes\_count           | 記録をLikeされた数で並び替えます。`asc` または `desc` が指定できます。                                   | sort\_likes\_count=desc           |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/records?filter_episode_id=74669&access_token=(access_token)
```

```javascript
{
  "records": [
    {
      "id": 425551,
      "comment": "ゆるふわ田舎アニメかと思ったらギャグと下ネタが多めのコメディアニメだった。これはこれで。日岡さんの声良いなあ。",
      "rating": 4,
      "is_modified": false,
      "likes_count": 0,
      "comments_count": 0,
      "created_at": "2016-04-11T14:19:13.974Z",
      "user": {
        "id": 2,
        "username": "shimbaco",
        "name": "Koji Shimba",
        "description": "アニメ好きが高じてこのサービスを作りました。聖地巡礼を年に数回しています。",
        "url": "http://shimba.co",
        "avatar_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_avatars/master/d8af7adc8122c96ba7639218fd8b5ede332d42f2.jpg?1431357292",
        "background_image_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_background_images/master/ee15d577fb2f2d61bdaf700cfab894b286a5762d.jpg?1486753229",
        "records_count": 1906,
        "created_at": "2014-03-02T15:38:40.000Z"
      },
      "work": {
        "id": 4670,
        "title": "くまみこ",
        "title_kana": "くまみこ",
        "media": "tv",
        "media_text": "TV",
        "season_name": "2016-spring",
        "season_name_text": "2016年春",
        "released_on": "",
        "released_on_about": "",
        "official_site_url": "http://kmmk.tv/",
        "wikipedia_url": "https://ja.wikipedia.org/wiki/%E3%81%8F%E3%81%BE%E3%81%BF%E3%81%93",
        "twitter_username": "kmmk_anime",
        "twitter_hashtag": "kumamiko",
        "episodes_count": 6,
        "watchers_count": 609
      },
      "episode": {
        "id": 74669,
        "number": "1",
        "number_text": "第壱話",
        "sort_number": 10,
        "title": "クマと少女 お別れの時",
        "records_count": 183,
        "record_comments_count": 53
      }
    },
...
```


# GET /v1/works

Annictに登録されている作品情報を取得することができます。

## フィールド

| 名前                                                        | 概要                                                                                                                            |
| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| id                                                        | 作品のID                                                                                                                         |
| title                                                     | 作品のタイトル                                                                                                                       |
| title\_kana                                               | 作品タイトルの読み仮名                                                                                                                   |
| media                                                     | リリース媒体 `tv, ova, movie, web, other`                                                                                           |
| media\_text                                               | リリース媒体 (表記用) `TV, OVA, 映画, Web, その他`                                                                                          |
| season\_name                                              | リリース時期                                                                                                                        |
| season\_name\_text                                        | リリース時期 (表記用)                                                                                                                  |
| released\_on                                              | リリース日                                                                                                                         |
| released\_on\_about                                       | 未確定な大体のリリース日                                                                                                                  |
| official\_site\_url                                       | 公式サイトのURL                                                                                                                     |
| wikipedia\_url                                            | WikipediaのURL                                                                                                                 |
| twitter\_username                                         | 公式Twitterアカウントのusername                                                                                                       |
| twitter\_hashtag                                          | Twitterの作品に関するハッシュタグ                                                                                                          |
| syobocal\_tid                                             | しょぼいカレンダーのタイトルID                                                                                                              |
| mal\_anime\_id                                            | MyAnimeListの作品ID                                                                                                              |
| images.facebook.og\_image\_url                            | `official_site_url` のページで取得できる `og:image` のURL                                                                                |
| images.twitter.(mini/normal/bigger/original)\_avatar\_url | Twitterアカウントのアバター画像。`mini`, `normal`, `bigger`, `original` の4種類のサイズがあります                                                      |
| images.twitter.image\_url                                 | `official_site_url` のページで取得できる `twitter:image` のURL                                                                           |
| images.recommended\_url                                   | `facebook.og_image_url`, `twitter.bigger_avatar_url`, `twitter.image_url` のうち、解像度が一番大きい画像のURL。扱いやすい画像のURLが高確率で格納されるプロパティになります |
| episodes\_count                                           | エピソード数                                                                                                                        |
| watchers\_count                                           | 見てる / 見たい / 見た人の数                                                                                                             |
| reviews\_count                                            | レビュー数                                                                                                                         |
| no\_episodes                                              | エピソードが存在しない作品かどうか。例えば映画はエピソードが存在しない作品なので、`true` になります                                                                         |

## パラメータ

| 名前                    | 概要                                                                | 使用例                        |
| --------------------- | ----------------------------------------------------------------- | -------------------------- |
| fields                | レスポンスボディに含まれるデータのフィールドを絞り込みます。                                    | fields=id,title            |
| filter\_ids           | 作品を作品IDで絞り込みます。                                                   | filter\_ids=1,2,3          |
| filter\_season        | 作品をリリース時期で絞り込みます。`2016-all` としたときは、2016年にリリースされる作品全てを取得することができます。 | filter\_season=2016-spring |
| filter\_title         | 作品をタイトルで絞り込みます。                                                   | filter\_title=shirobako    |
| page                  | ページ数を指定します。                                                       | page=2                     |
| per\_page             | 1ページに何件取得するかを指定します。デフォルトは `25` 件で、`50` 件まで指定できます。                 | per\_page=30               |
| sort\_id              | 作品を作品IDで並び替えます。`asc` または `desc` が指定できます。                          | sort\_id=desc              |
| sort\_season          | 作品をリリース時期で並び替えます。`asc` または `desc` が指定できます。                        | sort\_season=desc          |
| sort\_watchers\_count | 作品をWatchersの数で並び替えます。`asc` または `desc` が指定できます。                    | sort\_watchers\_count=desc |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/works?access_token=(access_token)
```

```javascript
{
  "works": [
    {
      "id": 4168,
      "title": "SHIROBAKO",
      "title_kana": "しろばこ",
      "media": "tv",
      "media_text": "TV",
      "season_name": "2014-autumn",
      "season_name_text": "2014年秋",
      "released_on": "2014-10-09",
      "released_on_about": "",
      "official_site_url": "http://shirobako-anime.com",
      "wikipedia_url": "http://ja.wikipedia.org/wiki/SHIROBAKO",
      "twitter_username": "shirobako_anime",
      "twitter_hashtag": "musani",
      "syobocal_tid": "3524",
      "mal_anime_id": "25835",
      "images": {
        "recommended_url": "http://shirobako-anime.com/images/ogp.jpg",
        "facebook": {
          "og_image_url": "http://shirobako-anime.com/images/ogp.jpg"
        },
        "twitter": {
          "mini_avatar_url": "https://twitter.com/shirobako_anime/profile_image?size=mini",
          "normal_avatar_url": "https://twitter.com/shirobako_anime/profile_image?size=normal",
          "bigger_avatar_url": "https://twitter.com/shirobako_anime/profile_image?size=bigger",
          "original_avatar_url": "https://twitter.com/shirobako_anime/profile_image?size=original",
          "image_url": ""
        }
      },
      "episodes_count": 24,
      "watchers_count": 1254
    },
  ]
...
```


# GET /v1/staffs

Annictに登録されているスタッフ情報を取得することができます。

## フィールド

| 名前                      | 概要                                                                                                                  |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------- |
| id                      | ID                                                                                                                  |
| name                    | 名前                                                                                                                  |
| name\_en                | 名前 (英語表記)                                                                                                           |
| role\_text              | 担当。主要な担当名 (監督やアニメーション制作など) が登録されています。                                                                               |
| role\_other             | その他の担当                                                                                                              |
| role\_other\_en         | その他の担当 (英語表記)                                                                                                       |
| sort\_number            | ソート番号                                                                                                               |
| work                    | 紐づく作品情報。取得できるフィールドは [Works](/docs/ja/api/v1/works) と同じです。                                                           |
| person または organization | 紐づく人物または団体情報。取得できるフィールドは [People](/docs/ja/api/v1/people) または [Organizations](/docs/ja/api/v1/organizations) と同じです。 |

## パラメータ

| 名前                 | 概要                                                | 使用例                     |
| ------------------ | ------------------------------------------------- | ----------------------- |
| 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 |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/staffs?access_token=(access_token)&filter_ids=35319
```

```javascript
{
  "staffs": [
    {
      "id": 35319,
      "name": "京都アニメーション",
      "name_en": "",
      "role_text": "アニメーション制作",
      "role_other": "",
      "role_other_en": "",
      "sort_number": 200,
      "work": {
        "id": 4308,
        "title": "響け！ユーフォニアム",
        ...
      },
      "organization": {
        "id": 74,
        "name": "京都アニメーション",
        ...
      }
    }
  ],
  "total_count": 1,
  "next_page": null,
  "prev_page": null
}
```


# GET /v1/organizations

Annictに登録されている団体情報を取得することができます。

## フィールド

| 名前                             | 概要                            |
| ------------------------------ | ----------------------------- |
| id                             | ID                            |
| name                           | 名前                            |
| name\_kana                     | 名前 (かな表記)                     |
| name\_en                       | 名前 (英語表記)                     |
| url                            | 公式サイト等のURL                    |
| url\_en                        | 公式サイト等のURL (英語圏向け)            |
| wikipedia\_url                 | WikipediaのURL                 |
| wikipedia\_url\_en             | WikipediaのURL (英語圏向け)         |
| twitter\_username              | Twitterアカウントのusername         |
| twitter\_username\_en          | Twitterアカウントのusername (英語圏向け) |
| favorite\_organizations\_count | お気に入りに入れている人の数                |
| staffs\_count                  | スタッフとして登録されている作品の数            |

## パラメータ

| 名前           | 概要                                                | 使用例               |
| ------------ | ------------------------------------------------- | ----------------- |
| fields       | レスポンスボディに含まれるデータのフィールドを絞り込みます。                    | fields=id,name    |
| filter\_ids  | 団体をIDで絞り込みます。                                     | filter\_ids=1,2,3 |
| filter\_name | 団体を名前で絞り込みます。                                     | filter\_name=株式会社 |
| page         | ページ数を指定します。                                       | page=2            |
| per\_page    | 1ページに何件取得するかを指定します。デフォルトは `25` 件で、`50` 件まで指定できます。 | per\_page=30      |
| sort\_id     | 団体をIDで並び替えます。`asc` または `desc` が指定できます。            | sort\_id=desc     |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/organizations?access_token=(access_token)&filter_ids=3
```

```javascript
{
  "organizations": [
    {
      "id": 3,
      "name": "P.A.WORKS",
      "name_kana": "ぴーえーわーくす",
      "name_en": "P.A.WORKS",
      "url": "http://www.pa-works.jp/",
      "url_en": "https://www.pa-works.jp/en/",
      "wikipedia_url": "https://ja.wikipedia.org/wiki/%E3%83%94%E3%83%BC%E3%82%A8%E3%83%BC%E3%83%AF%E3%83%BC%E3%82%AF%E3%82%B9",
      "wikipedia_url_en": "",
      "twitter_username": "PAWORKS_info",
      "twitter_username_en": "PAWORKS_eng",
      "favorite_organizations_count": 81,
      "staffs_count": 23
    }
  ],
  "total_count": 1,
  "next_page": null,
  "prev_page": null
}
```


# GET /v1/me/following\_activities

自分がフォローしているユーザのアクティビティを取得することができます。

## フィールド

取得できるフィールドは [Activities](/docs/ja/api/v1/activities) と同じです。

## パラメータ

| 名前              | 概要                                                                                            | 使用例                                                      |
| --------------- | --------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| fields          | レスポンスボディに含まれるデータのフィールドを絞り込みます。                                                                | fields=id,work.title                                     |
| filter\_actions | アクションで絞り込みます。                                                                                 | filter\_actions=create\_record,create\_multiple\_records |
| filter\_muted   | ミュート機能でミュートしているユーザを除外するかどうかを指定します。 `true` で除外、 `false` で除外しないようにできます。デフォルトは `true` (除外する) です。 | filter\_muted=false                                      |
| page            | ページ数を指定します。                                                                                   | page=2                                                   |
| per\_page       | 1ページに何件取得するかを指定します。デフォルトは `25` 件で、`50` 件まで指定できます。                                             | per\_page=30                                             |
| sort\_id        | IDで並び替えます。`asc` または `desc` が指定できます。                                                           | sort\_id=desc                                            |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/me/following_activities?access_token=(access_token)&sort_id=desc&per_page=1
```

```javascript
{
  "activities": [
    {
      "id": 1504708,
      "user": {
        "id": 2,
        "username": "shimbaco",
        "name": "Koji Shimba",
        "description": "アニメ好きが高じてこのサービスを作りました。聖地巡礼を年に数回しています。",
        "url": "http://shimba.co",
        "avatar_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_avatars/master/d8af7adc8122c96ba7639218fd8b5ede332d42f2.jpg?1431357292",
        "background_image_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_background_images/master/ee15d577fb2f2d61bdaf700cfab894b286a5762d.jpg?1486753229",
        "records_count": 2369,
        "created_at": "2014-03-02T15:38:40.000Z"
      },
      "action": "create_record",
      "created_at": "2017-02-22T13:24:44.761Z",
      "work": {
        "id": 5036,
        "title": "小林さんちのメイドラゴン",
        "title_kana": "こばやしさんちのめいどらごん",
        "media": "tv",
        "media_text": "TV",
        "released_on": "",
        "released_on_about": "",
        "official_site_url": "http://maidragon.jp/",
        "wikipedia_url": "https://ja.wikipedia.org/wiki/%E5%B0%8F%E6%9E%97%E3%81%95%E3%82%93%E3%81%A1%E3%81%AE%E3%83%A1%E3%82%A4%E3%83%89%E3%83%A9%E3%82%B4%E3%83%B3",
        "twitter_username": "maidragon_anime",
        "twitter_hashtag": "maidragon",
        "episodes_count": 7,
        "watchers_count": 448,
        "season_name": "2017-winter",
        "season_name_text": "2017年冬"
      },
      "episode": {
        "id": 89678,
        "number": "6",
        "number_text": "#6",
        "sort_number": 60,
        "title": "お宅訪問！(してないお宅もあります)",
        "records_count": 89,
        "record_comments_count": 24
      },
      "record": {
        "id": 864718,
        "comment": "",
        "rating": null,
        "is_modified": false,
        "likes_count": 0,
        "comments_count": 0,
        "created_at": "2017-02-22T13:24:39.353Z"
      }
    }
  ],
  "total_count": 138030,
  "next_page": 2,
  "prev_page": null
}
```


# GET /v1/people

Annictに登録されている人物情報を取得することができます。

## フィールド

| 名前                      | 概要                            |
| ----------------------- | ----------------------------- |
| id                      | ID                            |
| name                    | 名前                            |
| name\_kana              | 名前 (かな表記)                     |
| name\_en                | 名前 (英語表記)                     |
| nickname                | ニックネーム                        |
| nickname\_en            | ニックネーム (英語表記)                 |
| gender\_text            | 性別                            |
| url                     | 公式サイト等のURL                    |
| url\_en                 | 公式サイト等のURL (英語圏向け)            |
| wikipedia\_url          | WikipediaのURL                 |
| wikipedia\_url\_en      | WikipediaのURL (英語圏向け)         |
| twitter\_username       | Twitterアカウントのusername         |
| twitter\_username\_en   | Twitterアカウントのusername (英語圏向け) |
| birthday                | 誕生日                           |
| blood\_type             | 血液型                           |
| height                  | 身長                            |
| favorite\_people\_count | お気に入りに入れている人の数                |
| casts\_count            | キャストとして登録されている作品の数            |
| staffs\_count           | スタッフとして登録されている作品の数            |
| prefecture              | 出身地                           |

## パラメータ

| 名前           | 概要                                                | 使用例               |
| ------------ | ------------------------------------------------- | ----------------- |
| fields       | レスポンスボディに含まれるデータのフィールドを絞り込みます。                    | fields=id,name    |
| filter\_ids  | 人物をIDで絞り込みます。                                     | filter\_ids=1,2,3 |
| filter\_name | 人物を名前で絞り込みます。                                     | filter\_name=井上   |
| page         | ページ数を指定します。                                       | page=2            |
| per\_page    | 1ページに何件取得するかを指定します。デフォルトは `25` 件で、`50` 件まで指定できます。 | per\_page=30      |
| sort\_id     | 人物をIDで並び替えます。`asc` または `desc` が指定できます。            | sort\_id=desc     |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/people?access_token=(access_token)&filter_ids=7118
```

```javascript
{
  "people": [
    {
      "id": 7118,
      "name": "水瀬いのり",
      "name_kana": "みなせいのり",
      "name_en": "Minase, Inori",
      "nickname": "いのりん、いのすけ",
      "nickname_en": "",
      "gender_text": "女性",
      "url": "http://axl-one.com/talent/minase.html",
      "url_en": "",
      "wikipedia_url": "https://ja.wikipedia.org/wiki/%E6%B0%B4%E7%80%AC%E3%81%84%E3%81%AE%E3%82%8A",
      "wikipedia_url_en": "",
      "twitter_username": "inoriminase",
      "twitter_username_en": "",
      "birthday": "1995-12-02",
      "blood_type": "b",
      "height": 154,
      "favorite_people_count": 74,
      "casts_count": 58,
      "staffs_count": 0,
      "prefecture": {
        "id": 13,
        "name": "東京都"
      }
    }
  ],
  "total_count": 1,
  "next_page": null,
  "prev_page": null
}
```


# me-records

## POST /v1/me/records

エピソードへの記録が作成できます。

**このリクエストには `write` スコープが必要になります。**

### パラメータ

| 名前              | 概要                                                                                  | データ例                 |
| --------------- | ----------------------------------------------------------------------------------- | -------------------- |
| episode\_id     | **\[必須]** エピソードID                                                                   | 1234                 |
| comment         | 感想                                                                                  | あぁ^～心がぴょんぴょんするんじゃぁ^～ |
| rating          | **\[非推奨]** 旧レーティング。今後は `rating_state` を使用してください。                                    | 4.5                  |
| rating\_state   | レーティングの種類。`bad` `average` `good` `great` が入力できます。                                   | great                |
| share\_twitter  | 記録をTwitterにシェアするかどうか。`true` または `false` が入力できます。指定しなかったときは `false` (シェアしない) になります。  | true                 |
| share\_facebook | 記録をFacebookにシェアするかどうか。`true` または `false` が入力できます。指定しなかったときは `false` (シェアしない) になります。 | true                 |

### リクエスト例

```
$ curl -X POST "https://api.annict.com/v1/me/records?episode_id=5013&comment=あぁ^～心がぴょんぴょんするんじゃぁ^～&access_token=(access_token)"
```

```javascript
{
  "id": 470491,
  "comment": "あぁ^～心がぴょんぴょんするんじゃぁ^～",
  "rating": null,
  "is_modified": false,
  "likes_count": 0,
  "comments_count": 0,
  "created_at": "2016-05-07T09:40:32.159Z",
  "user": {
    "id": 2,
    "username": "shimbaco",
    "name": "Koji Shimba",
    "description": "",
    "url": null,
    "avatar_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_avatars/master/d8af7adc8122c96ba7639218fd8b5ede332d42f2.jpg?1431357292",
    "background_image_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_background_images/master/ee15d577fb2f2d61bdaf700cfab894b286a5762d.jpg?1486753229",
    "records_count": 123,
    "created_at": "2016-05-03T19:06:59.929Z"
  },
  "work": {
    "id": 3994,
    "title": "ご注文はうさぎですか？",
    "title_kana": "ごちゅうもんはうさぎですか",
    "media": "tv",
    "media_text": "TV",
    "season_name": "2014-spring",
    "season_name_text": "2014年春",
    "released_on": "2014-04-10",
    "released_on_about": "",
    "official_site_url": "http://www.gochiusa.com/",
    "wikipedia_url": "http://ja.wikipedia.org/wiki/%E3%81%94%E6%B3%A8%E6%96%87%E3%81%AF%E3%81%86%E3%81%95%E3%81%8E%E3%81%A7%E3%81%99%E3%81%8B%3F#.E3.83.86.E3.83.AC.E3.83.93.E3.82.A2.E3.83.8B.E3.83.A1",
    "twitter_username": "usagi_anime",
    "twitter_hashtag": "gochiusa",
    "episodes_count": 12,
    "watchers_count": 850
  },
  "episode": {
    "id": 5013,
    "number": null,
    "number_text": "第1羽",
    "sort_number": 1,
    "title": "ひと目で尋常でないもふもふだと見抜いたよ",
    "records_count": 103,
    "record_comments_count": 3
  }
}
```

## PATCH /v1/me/records/:id

作成した記録を編集することができます。

**このリクエストには `write` スコープが必要になります。**

### パラメータ

| 名前              | 概要                                                                                  | データ例                 |
| --------------- | ----------------------------------------------------------------------------------- | -------------------- |
| id              | **\[必須]** 記録ID                                                                      | 1016                 |
| comment         | 感想                                                                                  | あぁ^～心がぴょんぴょんするんじゃぁ^～ |
| rating          | **\[非推奨]** 旧レーティング。今後は `rating_state` を使用してください。                                    | 4.5                  |
| rating\_state   | レーティングの種類。`bad` `average` `good` `great` が入力できます。                                   | great                |
| share\_twitter  | 記録をTwitterにシェアするかどうか。`true` または `false` が入力できます。指定しなかったときは `false` (シェアしない) になります。  | true                 |
| share\_facebook | 記録をFacebookにシェアするかどうか。`true` または `false` が入力できます。指定しなかったときは `false` (シェアしない) になります。 | true                 |

### リクエスト例

```
$ curl -X PATCH "https://api.annict.com/v1/me/records/1016?comment=あぁ^～心がぴょんぴょんするんじゃぁ^～&share_facebook=true&access_token=(access_token)"
```

```javascript
{
  "id": 1016,
  "comment": "あぁ^～心がぴょんぴょんするんじゃぁ^～",
  "rating": 5.0,
  "is_modified": true,
  "likes_count": 0,
  "comments_count": 0,
  "created_at": "2016-05-07T09:40:32.159Z",
  "user": {
    "id": 2,
    "username": "shimbaco",
    "name": "Koji Shimba",
    "description": "",
    "url": null,
    "avatar_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_avatars/master/d8af7adc8122c96ba7639218fd8b5ede332d42f2.jpg?1431357292",
    "background_image_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_background_images/master/ee15d577fb2f2d61bdaf700cfab894b286a5762d.jpg?1486753229",
    "records_count": 1234,
    "created_at": "2016-05-03T19:06:59.929Z"
  },
  "work": {
    "id": 3994,
    "title": "ご注文はうさぎですか？",
    "title_kana": "ごちゅうもんはうさぎですか",
    "media": "tv",
    "media_text": "TV",
    "season_name": "2014-spring",
    "season_name_text": "2014年春",
    "released_on": "2014-04-10",
    "released_on_about": "",
    "official_site_url": "http://www.gochiusa.com/",
    "wikipedia_url": "http://ja.wikipedia.org/wiki/%E3%81%94%E6%B3%A8%E6%96%87%E3%81%AF%E3%81%86%E3%81%95%E3%81%8E%E3%81%A7%E3%81%99%E3%81%8B%3F#.E3.83.86.E3.83.AC.E3.83.93.E3.82.A2.E3.83.8B.E3.83.A1",
    "twitter_username": "usagi_anime",
    "twitter_hashtag": "gochiusa",
    "episodes_count": 12,
    "watchers_count": 850
  },
  "episode": {
    "id": 5013,
    "number": null,
    "number_text": "第1羽",
    "sort_number": 1,
    "title": "ひと目で尋常でないもふもふだと見抜いたよ",
    "records_count": 103,
    "record_comments_count": 3
  }
}
```

## DELETE /v1/me/records/:id

作成した記録を削除することができます。

**このリクエストには `write` スコープが必要になります。**

### パラメータ

| 名前 | 概要             | データ例 |
| -- | -------------- | ---- |
| id | **\[必須]** 記録ID | 1016 |

### リクエスト例

```
$ curl -X DELETE "https://api.annict.com/v1/me/records/1016?access_token=(access_token)"
```

```
HTTP/1.1 204 No Content
```


# GET /v1/reviews

作品へのレビューを取得することができます。

## フィールド

| 名前                       | 概要                                                                             |
| ------------------------ | ------------------------------------------------------------------------------ |
| id                       | レビューID                                                                         |
| title                    | **\[非推奨]** レビュータイトル                                                            |
| body                     | 感想                                                                             |
| rating\_animation\_state | レビューしたときに付けられたレーティング (作画)。`bad` `average` `good` `great` の4種類のうち1つが入っています。     |
| rating\_music\_state     | レビューしたときに付けられたレーティング (音楽)。`bad` `average` `good` `great` の4種類のうち1つが入っています。     |
| rating\_story\_state     | レビューしたときに付けられたレーティング (ストーリー)。`bad` `average` `good` `great` の4種類のうち1つが入っています。  |
| rating\_character\_state | レビューしたときに付けられたレーティング (キャラクター)。`bad` `average` `good` `great` の4種類のうち1つが入っています。 |
| rating\_overall\_state   | レビューしたときに付けられたレーティング (全体)。`bad` `average` `good` `great` の4種類のうち1つが入っています。     |
| likes\_count             | Likeされた数                                                                       |
| impressions\_count       | PV数                                                                            |
| created\_at              | レビューが投稿された日時                                                                   |
| modified\_at             | レビューが編集された日時                                                                   |
| user                     | このレビューを投稿した利用者の情報                                                              |
| work                     | このレビューが紐づく作品情報。取得できるフィールドは [Works](/docs/ja/api/v1/works) と同じです。               |

## パラメータ

| 名前                        | 概要                                                                                 | 使用例                            |
| ------------------------- | ---------------------------------------------------------------------------------- | ------------------------------ |
| fields                    | レスポンスボディに含まれるデータのフィールドを絞り込みます。                                                     | fields=id,title                |
| filter\_ids               | レビューをレビューIDで絞り込みます。                                                                | filter\_ids=1,2,3              |
| filter\_work\_id          | レビューを作品IDで絞り込みます。                                                                  | filter\_work\_id=1111          |
| filter\_has\_review\_body | レビューを感想のあるなしで絞り込みます。感想付きのレビューのみに絞り込むときは `true` を、感想の無い記録のみに絞り込むときは `false` を指定します。 | filter\_has\_review\_body=true |
| page                      | ページ数を指定します。                                                                        | page=2                         |
| per\_page                 | 1ページに何件取得するかを指定します。デフォルトは `25` 件で、`50` 件まで指定できます。                                  | per\_page=30                   |
| sort\_id                  | レビューをレビューIDで並び替えます。`asc` または `desc` が指定できます。                                       | sort\_id=desc                  |
| sort\_likes\_count        | レビューをLikeされた数で並び替えます。`asc` または `desc` が指定できます。                                     | sort\_likes\_count=desc        |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/reviews?filter_work_id=3994&access_token=(access_token)
```

```javascript
{
    "reviews": [
        {
            "id": 594,
            "title": "あぁ^～心がぴょんぴょんするんじゃぁ^～",
            "body": "みんなかわいい",
            "rating_animation_state": "good",
            "rating_music_state": "good",
            "rating_story_state": "good",
            "rating_character_state": "great",
            "rating_overall_state": "great",
            "likes_count": 0,
            "impressions_count": 1,
            "modified_at": null,
            "created_at": "2017-06-24T18:51:35.075Z",
            "user": {
                "id": 2,
                "username": "shimbaco",
                "name": "Koji Shimba",
                "description": "アニメ好きが高じてこのサービスを作りました。聖地巡礼を年に数回しています。",
                "url": "http://shimba.co",
                "avatar_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_avatars/master/d8af7adc8122c96ba7639218fd8b5ede332d42f2.jpg?1431357292",
                "background_image_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_background_images/master/ee15d577fb2f2d61bdaf700cfab894b286a5762d.jpg?1486753229",
                "records_count": 1906,
                "created_at": "2014-03-02T15:38:40.000Z"
            },
            "work": {
                "id": 3994,
                "title": "ご注文はうさぎですか？",
                "title_kana": "ごちゅうもんはうさぎですか",
                "media": "tv",
                "media_text": "TV",
                "released_on": "2014-04-10",
                "released_on_about": "",
                "official_site_url": "http://www.gochiusa.com/",
                "wikipedia_url": "http://ja.wikipedia.org/wiki/%E3%81%94%E6%B3%A8%E6%96%87%E3%81%AF%E3%81%86%E3%81%95%E3%81%8E%E3%81%A7%E3%81%99%E3%81%8B%3F#.E3.83.86.E3.83.AC.E3.83.93.E3.82.A2.E3.83.8B.E3.83.A1",
                "twitter_username": "usagi_anime",
                "twitter_hashtag": "gochiusa",
                "images": {
                    "recommended_url": "https://twitter.com/usagi_anime/profile_image?size=bigger",
                    "facebook": {
                        "og_image_url": ""
                    },
                    "twitter": {
                        "mini_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=mini",
                        "normal_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=normal",
                        "bigger_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=bigger",
                        "original_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=original",
                        "image_url": ""
                    }
                },
                "episodes_count": 12,
                "watchers_count": 1463,
                "season_name": "2014-spring",
                "season_name_text": "2014年春"
            }
        },
        ...
    ],
    "total_count": 6,
    "next_page": null,
    "prev_page": null
}
```


# GET /v1/me/works

自分がステータスを設定している作品の情報を取得することができます。

## フィールド

[GET /v1/works](/docs/ja/api/v1/works) のフィールドに加えて、下記のフィールドが存在します。

| 名前          | 概要       |
| ----------- | -------- |
| status.kind | ステータスの種類 |

## パラメータ

| 名前                    | 概要                                                                                | 使用例                        |
| --------------------- | --------------------------------------------------------------------------------- | -------------------------- |
| fields                | レスポンスボディに含まれるデータのフィールドを絞り込みます。                                                    | fields=id,title            |
| filter\_ids           | 作品を作品IDで絞り込みます。                                                                   | filter\_ids=1,2,3          |
| filter\_season        | 作品をリリース時期で絞り込みます。`2016-all` としたときは、2016年にリリースされる作品全てを取得することができます。                 | filter\_season=2016-spring |
| filter\_title         | 作品をタイトルで絞り込みます。                                                                   | filter\_title=shirobako    |
| filter\_status        | 作品をステータスで絞り込みます。`wanna_watch, watching, watched, on_hold, stop_watching` が指定できます。 | filter\_status=watching    |
| page                  | ページ数を指定します。                                                                       | page=2                     |
| per\_page             | 1ページに何件取得するかを指定します。デフォルトは `25` 件で、`50` 件まで指定できます。                                 | per\_page=30               |
| sort\_id              | 作品を作品IDで並び替えます。`asc` または `desc` が指定できます。                                          | sort\_id=desc              |
| sort\_season          | 作品をリリース時期で並び替えます。`asc` または `desc` が指定できます。                                        | sort\_season=desc          |
| sort\_watchers\_count | 作品をWatchersの数で並び替えます。`asc` または `desc` が指定できます。                                    | sort\_watchers\_count=desc |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/me/works?access_token=(access_token)
```

```javascript
{
  "works": [
    {
      "id": 4681,
      "title": "ふらいんぐうぃっち",
      "title_kana": "ふらいんぐうぃっち",
      "media": "tv",
      "media_text": "TV",
      "season_name": "2016-spring",
      "season_name_text": "2016年春",
      "released_on": "",
      "released_on_about": "",
      "official_site_url": "http://www.flyingwitch.jp/",
      "wikipedia_url": "https://ja.wikipedia.org/wiki/%E3%81%B5%E3%82%89%E3%81%84%E3%82%93%E3%81%90%E3%81%86%E3%81%83%E3%81%A3%E3%81%A1",
      "twitter_username": "flying_tv",
      "twitter_hashtag": "flyingwitch",
      "episodes_count": 5,
      "watchers_count": 695,
      "status": {
        "kind": "watching"
      }
    }
  ],
...
```


# GET /v1/activities

アクティビティを取得することができます。

## フィールド

### アクティビティ共通

| 名前          | 概要                                                                                                       |
| ----------- | -------------------------------------------------------------------------------------------------------- |
| id          | アクティビティID                                                                                                |
| user        | ユーザ情報。取得できるフィールドは [Users](/docs/ja/api/v1/users) と同じです。                                                  |
| work        | 作品情報。取得できるフィールドは [Works](/docs/ja/api/v1/works) と同じです。                                                   |
| action      | アクティビティの種類。`create_record` (記録), `create_multiple_records` (一括記録), `create_status` (ステータス変更) の3種類が存在します。 |
| created\_at | アクティビティ作成日時                                                                                              |

上記フィールド以外に、 `action` ごとに異なるフィールドが存在します。

### status: create\_record

| 名前      | 概要                                                                                                                                          |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| episode | 記録されたエピソード情報。取得できるフィールドは [Episodes](https://github.com/annict/docs/tree/ecd19a716310ae36b351411be7db00589a6c5b55/api/v1/episodes.md) と同じです。 |
| record  | 記録情報。取得できるフィールドは [Records](/docs/ja/api/v1/records) と同じです。                                                                                  |

### status: create\_review

| 名前     | 概要                                                           |
| ------ | ------------------------------------------------------------ |
| review | レビュー情報。取得できるフィールドは [Reviews](/docs/ja/api/v1/reviews) と同じです。 |

### status: create\_multiple\_records

| 名前                       | 概要                                                                   |
| ------------------------ | -------------------------------------------------------------------- |
| multiple\_record.episode | 記録されたエピソード情報。取得できるフィールドは [Episodes](/docs/ja/api/v1/episodes) と同じです。 |
| multiple\_record.record  | 記録情報。取得できるフィールドは [Records](/docs/ja/api/v1/records) と同じです。           |

### status: create\_status

| 名前          | 概要       |
| ----------- | -------- |
| status.kind | ステータスの種類 |

## パラメータ

| 名前               | 概要                                                | 使用例                       |
| ---------------- | ------------------------------------------------- | ------------------------- |
| fields           | レスポンスボディに含まれるデータのフィールドを絞り込みます。                    | fields=id,work.title      |
| filter\_user\_id | ユーザIDで絞り込みます。                                     | filter\_user\_id=2        |
| filter\_username | ユーザ名で絞り込みます。                                      | filter\_username=shimbaco |
| page             | ページ数を指定します。                                       | page=2                    |
| per\_page        | 1ページに何件取得するかを指定します。デフォルトは `25` 件で、`50` 件まで指定できます。 | per\_page=30              |
| sort\_id         | IDで並び替えます。`asc` または `desc` が指定できます。               | sort\_id=desc             |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/activities?access_token=(access_token)&sort_id=desc&filter_username=shimbaco&per_page=1
```

```javascript
  "activities": [
    {
      "id": 1504708,
      "user": {
        "id": 2,
        "username": "shimbaco",
        "name": "Koji Shimba",
        "description": "アニメ好きが高じてこのサービスを作りました。聖地巡礼を年に数回しています。",
        "url": "http://shimba.co",
        "avatar_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_avatars/master/d8af7adc8122c96ba7639218fd8b5ede332d42f2.jpg?1431357292",
        "background_image_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_background_images/master/ee15d577fb2f2d61bdaf700cfab894b286a5762d.jpg?1486753229",
        "records_count": 2369,
        "created_at": "2014-03-02T15:38:40.000Z"
      },
      "action": "create_record",
      "created_at": "2017-02-22T13:24:44.761Z",
      "work": {
        "id": 5036,
        "title": "小林さんちのメイドラゴン",
        "title_kana": "こばやしさんちのめいどらごん",
        "media": "tv",
        "media_text": "TV",
        "released_on": "",
        "released_on_about": "",
        "official_site_url": "http://maidragon.jp/",
        "wikipedia_url": "https://ja.wikipedia.org/wiki/%E5%B0%8F%E6%9E%97%E3%81%95%E3%82%93%E3%81%A1%E3%81%AE%E3%83%A1%E3%82%A4%E3%83%89%E3%83%A9%E3%82%B4%E3%83%B3",
        "twitter_username": "maidragon_anime",
        "twitter_hashtag": "maidragon",
        "episodes_count": 7,
        "watchers_count": 448,
        "season_name": "2017-winter",
        "season_name_text": "2017年冬"
      },
      "episode": {
        "id": 89678,
        "number": "6",
        "number_text": "#6",
        "sort_number": 60,
        "title": "お宅訪問！(してないお宅もあります)",
        "records_count": 89,
        "record_comments_count": 24
      },
      "record": {
        "id": 864718,
        "comment": "",
        "rating": null,
        "is_modified": false,
        "likes_count": 0,
        "comments_count": 0,
        "created_at": "2017-02-22T13:24:39.353Z"
      }
    }
  ],
  "total_count": 3705,
  "next_page": 2,
  "prev_page": null
}
```


# GET /v1/characters

Annictに登録されているキャラクター情報を取得することができます。

## フィールド

| 名前                          | 概要                                                            |
| --------------------------- | ------------------------------------------------------------- |
| id                          | ID                                                            |
| name                        | 名前                                                            |
| name\_kana                  | 名前 (かな表記)                                                     |
| name\_en                    | 名前 (英語表記)                                                     |
| nickname                    | ニックネーム                                                        |
| nickname\_en                | ニックネーム (英語表記)                                                 |
| birthday                    | 誕生日                                                           |
| birthday\_en                | 誕生日 (英語表記)                                                    |
| age                         | 年齢                                                            |
| age\_en                     | 年齢 (英語表記)                                                     |
| blood\_type                 | 血液型                                                           |
| blood\_type\_en             | 血液型 (英語表記)                                                    |
| height                      | 身長                                                            |
| height\_en                  | 身長 (英語表記)                                                     |
| weight                      | 体重                                                            |
| weight\_en                  | 体重 (英語表記)                                                     |
| nationality                 | 国籍                                                            |
| nationality\_en             | 国籍 (英語表記)                                                     |
| occupation                  | 肩書き                                                           |
| occupation\_en              | 肩書き (英語表記)                                                    |
| description                 | キャラ紹介                                                         |
| description\_en             | キャラ紹介 (英語表記)                                                  |
| description\_source         | キャラ紹介の引用元                                                     |
| description\_source\_en     | キャラ紹介の引用元 (英語表記)                                              |
| favorite\_characters\_count | お気に入りに入れている人の数                                                |
| series                      | 紐づくシリーズ情報。取得できるフィールドは [Series](/docs/ja/api/v1/series) と同じです。 |

## パラメータ

| 名前           | 概要                                                | 使用例               |
| ------------ | ------------------------------------------------- | ----------------- |
| fields       | レスポンスボディに含まれるデータのフィールドを絞り込みます。                    | fields=id,name    |
| filter\_ids  | キャラクターをIDで絞り込みます。                                 | filter\_ids=1,2,3 |
| filter\_name | キャラクターを名前で絞り込みます。                                 | filter\_name=株式会社 |
| page         | ページ数を指定します。                                       | page=2            |
| per\_page    | 1ページに何件取得するかを指定します。デフォルトは `25` 件で、`50` 件まで指定できます。 | per\_page=30      |
| sort\_id     | キャラクターをIDで並び替えます。`asc` または `desc` が指定できます。        | sort\_id=desc     |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/characters?access_token=(access_token)&filter_ids=7510
```

```javascript
{
  "characters": [
    {
      "id": 7510,
      "name": "岡部倫太郎",
      "name_kana": "おかべりんたろう",
      "name_en": "Okabe, Rintarou",
      "kind": "STEINS;GATE",
      "nickname": "鳳凰院凶真、おかりん",
      "nickname_en": "Hououin, Kyouma",
      "birthday": "12月14日",
      "birthday_en": "December 14",
      "age": "18歳",
      "age_en": "18",
      "blood_type": "A型",
      "blood_type_en": "A",
      "height": "177 cm",
      "height_en": "177 cm",
      "weight": "59 kg",
      "weight_en": "59 kg",
      "nationality": "日本",
      "nationality_en": "Japan",
      "occupation": "狂気のマッドサイエンティスト",
      "occupation_en": "Crazy Mad Scientist",
      "description": "未来ガジェット研究所のラボメンNo.001にして、ラボの創設者。東京電機大学1年生。まゆりや橋田からは「オカリン」と呼ばれている。実家は青果店。",
      "description_en": "",
      "description_source": " Wikipedia【STEINS;GATEの登場人物】",
      "description_source_en": "",
      "favorite_characters_count": 13,
      "series": {
        "id": 50,
        "name": "Steins;Gate",
        "name_ro": "",
        "name_en": ""
      }
    }
  ],
  "total_count": 1,
  "next_page": null,
  "prev_page": null
}
```


# GET /v1/followers

Annictに登録されているユーザのフォロワー情報を取得することができます。

## フィールド

[GET /v1/users](/docs/ja/api/v1/users) のフィールドと同じです。

## パラメータ

| 名前               | 概要                                                | 使用例                       |
| ---------------- | ------------------------------------------------- | ------------------------- |
| fields           | レスポンスボディに含まれるデータのフィールドを絞り込みます。                    | fields=id,username        |
| filter\_user\_id | ユーザIDで絞り込みます。                                     | filter\_user\_id=2        |
| filter\_username | ユーザ名で絞り込みます。                                      | filter\_username=shimbaco |
| page             | ページ数を指定します。                                       | page=2                    |
| per\_page        | 1ページに何件取得するかを指定します。デフォルトは `25` 件で、`50` 件まで指定できます。 | per\_page=30              |
| sort\_id         | IDで並び替えます。`asc` または `desc` が指定できます。               | sort\_id=desc             |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/followers?access_token=(access_token)&filter_username=shimbaco&per_page=2
```

```javascript
{
  "users": [
    {
      "id": 7,
      "username": "akirafukuoka",
      "name": "akirafukuoka",
      "description": "FICC inc. http://www.ficc.jp  クリエイティブディレクター。RAW-Fi http://raw-fi.com  @raw_fi もよろしくお願いします。",
      "url": null,
      "avatar_url": "https://api-assets.annict.com/paperclip/profiles/6/tombo_avatars/master/480862747fc5f7152a031e24f0c0374dc71c539a.jpg?1431596794",
      "background_image_url": "https://api-assets.annict.com/paperclip/profiles/6/tombo_background_images/master/7e258e0189e9ee38f4dc0c57b2c9f6b39dd2cd95.jpg?1431596795",
      "records_count": 260,
      "created_at": "2014-03-10T04:11:54.000Z"
    },
    {
      "id": 8,
      "username": "310u8",
      "name": "Daisuke Nagai",
      "description": "歌って踊れるWebデザイナーです",
      "url": null,
      "avatar_url": "https://api-assets.annict.com/paperclip/profiles/7/tombo_avatars/master/cd7b66919fea1952e63855632665812839e2a394.jpg?1428129527",
      "background_image_url": "https://api-assets.annict.com/paperclip/profiles/7/tombo_avatars/master/cd7b66919fea1952e63855632665812839e2a394.jpg?1428129527",
      "records_count": 739,
      "created_at": "2014-03-10T04:11:55.000Z"
    }
  ],
  "total_count": 191,
  "next_page": 2,
  "prev_page": null
}
```


# POST /v1/me/statuses

作品のステータスを設定することができます。

**このリクエストには `write` スコープが必要になります。**

## パラメータ

| 名前       | 概要                                                                                                                                             | データ例         |
| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| work\_id | **\[必須]** 作品ID                                                                                                                                 | 1234         |
| kind     | **\[必須]** ステータスの種類。`wanna_watch` (見たい), `watching` (見てる), `watched` (見た), `on_hold` (中断), `stop_watching` (中止), または `no_select` (未選択) が指定できます。 | wanna\_watch |

## リクエスト例

```
$ curl -X POST https://api.annict.com/v1/me/statuses?work_id=438&kind=watching&access_token=(access_token)
```

```
HTTP/1.1 204 No Content
```


# me-reviews

## POST /v1/me/reviews

作品へのレビューが投稿できます。

**このリクエストには `write` スコープが必要になります。**

### パラメータ

| 名前                       | 概要                                                                                  | データ例                 |
| ------------------------ | ----------------------------------------------------------------------------------- | -------------------- |
| work\_id                 | **\[必須]** 作品ID                                                                      | 3994                 |
| title                    | **\[非推奨]** タイトル。現在このプロパティに入力された文字列は感想にマージされます。                                      | あぁ^～心がぴょんぴょんするんじゃぁ^～ |
| body                     | **\[必須]** 感想                                                                        | 僕は、リゼちゃん！◯（ ´∀｀ ）◯   |
| rating\_animation\_state | レーティング (映像)。`bad` `average` `good` `great` が入力できます。                                 | great                |
| rating\_music\_state     | レーティング (音楽)。`bad` `average` `good` `great` が入力できます。                                 | great                |
| rating\_story\_state     | レーティング (ストーリー)。`bad` `average` `good` `great` が入力できます。                              | great                |
| rating\_character\_state | レーティング (キャラクター)。`bad` `average` `good` `great` が入力できます。                             | great                |
| rating\_overall\_state   | レーティング (全体)。`bad` `average` `good` `great` が入力できます。                                 | great                |
| share\_twitter           | 記録をTwitterにシェアするかどうか。`true` または `false` が入力できます。指定しなかったときは `false` (シェアしない) になります。  | true                 |
| share\_facebook          | 記録をFacebookにシェアするかどうか。`true` または `false` が入力できます。指定しなかったときは `false` (シェアしない) になります。 | true                 |

### リクエスト例

```
$ curl -X POST "https://api.annict.com/v1/me/reviews?work_id=3994&title=あぁ^～心がぴょんぴょんするんじゃぁ^～&body=みんなかわいい&rating_animation_state=good&rating_music_state=good&rating_story_state=good&rating_character_state=great&rating_overall_state=great&access_token=(access_token)"
```

```javascript
{
    "id": 595,
    "title": "",
    "body": "あぁ^～心がぴょんぴょんするんじゃぁ^～\n\nみんなかわいい",
    "rating_animation_state": "good",
    "rating_music_state": "good",
    "rating_story_state": "good",
    "rating_character_state": "great",
    "rating_overall_state": "great",
    "likes_count": 0,
    "impressions_count": 0,
    "modified_at": null,
    "created_at": "2017-06-24T18:59:57.192Z",
    "user": {
        "id": 2,
        "username": "shimbaco",
        "name": "Koji Shimba",
        "description": "",
        "url": null,
        "avatar_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_avatars/master/d8af7adc8122c96ba7639218fd8b5ede332d42f2.jpg?1431357292",
        "background_image_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_background_images/master/ee15d577fb2f2d61bdaf700cfab894b286a5762d.jpg?1486753229",
        "records_count": 123,
        "created_at": "2016-05-03T19:06:59.929Z"
    },
    "work": {
        "id": 3994,
        "title": "ご注文はうさぎですか？",
        "title_kana": "ごちゅうもんはうさぎですか",
        "media": "tv",
        "media_text": "TV",
        "released_on": "2014-04-10",
        "released_on_about": "",
        "official_site_url": "http://www.gochiusa.com/",
        "wikipedia_url": "http://ja.wikipedia.org/wiki/%E3%81%94%E6%B3%A8%E6%96%87%E3%81%AF%E3%81%86%E3%81%95%E3%81%8E%E3%81%A7%E3%81%99%E3%81%8B%3F#.E3.83.86.E3.83.AC.E3.83.93.E3.82.A2.E3.83.8B.E3.83.A1",
        "twitter_username": "usagi_anime",
        "twitter_hashtag": "gochiusa",
        "images": {
            "recommended_url": "https://twitter.com/usagi_anime/profile_image?size=bigger",
            "facebook": {
                "og_image_url": ""
            },
            "twitter": {
                "mini_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=mini",
                "normal_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=normal",
                "bigger_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=bigger",
                "original_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=original",
                "image_url": ""
            }
        },
        "episodes_count": 12,
        "watchers_count": 1463,
        "season_name": "2014-spring",
        "season_name_text": "2014年春"
    }
}
```

## PATCH /v1/me/reviews/:id

作成したレビューを編集することができます。

**このリクエストには `write` スコープが必要になります。**

### パラメータ

| 名前                       | 概要                                                                                  | データ例                 |
| ------------------------ | ----------------------------------------------------------------------------------- | -------------------- |
| id                       | **\[必須]** 記録ID                                                                      | 1016                 |
| title                    | **\[非推奨]** タイトル。現在このプロパティに入力された文字列は感想にマージされます。                                      | あぁ^～心がぴょんぴょんするんじゃぁ^～ |
| body                     | **\[必須]** 感想                                                                        | 僕は、リゼちゃん！◯（ ´∀｀ ）◯   |
| rating\_animation\_state | レーティング (映像)。`bad` `average` `good` `great` が入力できます。                                 | great                |
| rating\_music\_state     | レーティング (音楽)。`bad` `average` `good` `great` が入力できます。                                 | great                |
| rating\_story\_state     | レーティング (ストーリー)。`bad` `average` `good` `great` が入力できます。                              | great                |
| rating\_character\_state | レーティング (キャラクター)。`bad` `average` `good` `great` が入力できます。                             | great                |
| rating\_overall\_state   | レーティング (全体)。`bad` `average` `good` `great` が入力できます。                                 | great                |
| share\_twitter           | 記録をTwitterにシェアするかどうか。`true` または `false` が入力できます。指定しなかったときは `false` (シェアしない) になります。  | true                 |
| share\_facebook          | 記録をFacebookにシェアするかどうか。`true` または `false` が入力できます。指定しなかったときは `false` (シェアしない) になります。 | true                 |

### リクエスト例

```
$ curl -X PATCH "https://api.annict.com/v1/me/reviews/595?body=みんなかわいい！！&rating_animation_state=good&rating_music_state=good&rating_story_state=good&rating_character_state=great&rating_overall_state=great&access_token=(access_token)"
```

```javascript
{
    "id": 595,
    "title": "あぁ^～心がぴょんぴょんするんじゃぁ^～",
    "body": "みんなかわいい！！",
    "rating_animation_state": "good",
    "rating_music_state": "good",
    "rating_story_state": "good",
    "rating_character_state": "great",
    "rating_overall_state": "great",
    "likes_count": 0,
    "impressions_count": 1,
    "modified_at": "2017-06-24T19:07:46.257Z",
    "created_at": "2017-06-24T18:59:57.192Z",
    "user": {
        "id": 2,
        "username": "shimbaco",
        "name": "Koji Shimba",
        "description": "",
        "url": null,
        "avatar_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_avatars/master/d8af7adc8122c96ba7639218fd8b5ede332d42f2.jpg?1431357292",
        "background_image_url": "https://api-assets.annict.com/paperclip/profiles/1/tombo_background_images/master/ee15d577fb2f2d61bdaf700cfab894b286a5762d.jpg?1486753229",
        "records_count": 123,
        "created_at": "2016-05-03T19:06:59.929Z"
    },
    "work": {
        "id": 3994,
        "title": "ご注文はうさぎですか？",
        "title_kana": "ごちゅうもんはうさぎですか",
        "media": "tv",
        "media_text": "TV",
        "released_on": "2014-04-10",
        "released_on_about": "",
        "official_site_url": "http://www.gochiusa.com/",
        "wikipedia_url": "http://ja.wikipedia.org/wiki/%E3%81%94%E6%B3%A8%E6%96%87%E3%81%AF%E3%81%86%E3%81%95%E3%81%8E%E3%81%A7%E3%81%99%E3%81%8B%3F#.E3.83.86.E3.83.AC.E3.83.93.E3.82.A2.E3.83.8B.E3.83.A1",
        "twitter_username": "usagi_anime",
        "twitter_hashtag": "gochiusa",
        "images": {
            "recommended_url": "https://twitter.com/usagi_anime/profile_image?size=bigger",
            "facebook": {
                "og_image_url": ""
            },
            "twitter": {
                "mini_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=mini",
                "normal_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=normal",
                "bigger_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=bigger",
                "original_avatar_url": "https://twitter.com/usagi_anime/profile_image?size=original",
                "image_url": ""
            }
        },
        "episodes_count": 12,
        "watchers_count": 1463,
        "season_name": "2014-spring",
        "season_name_text": "2014年春"
    }
}
```

## DELETE /v1/me/reviews/:id

作成した記録を削除することができます。

**このリクエストには `write` スコープが必要になります。**

### パラメータ

| 名前 | 概要             | データ例 |
| -- | -------------- | ---- |
| id | **\[必須]** 記録ID | 595  |

### リクエスト例

```
$ curl -X DELETE "https://api.annict.com/v1/me/reviews/595?access_token=(access_token)"
```

```
HTTP/1.1 204 No Content
```


# GET /v1/casts

Annictに登録されているキャスト情報を取得することができます。

## フィールド

| 名前           | 概要                                                                      |
| ------------ | ----------------------------------------------------------------------- |
| id           | ID                                                                      |
| name         | 名前                                                                      |
| name\_en     | 名前 (英語表記)                                                               |
| sort\_number | ソート番号                                                                   |
| work         | 紐づく作品情報。取得できるフィールドは [Works](/docs/ja/api/v1/works) と同じです。               |
| character    | 紐づくキャラクター情報。取得できるフィールドは [Characters](/docs/ja/api/v1/characters) と同じです。 |
| person       | 紐づく人物情報。取得できるフィールドは [People](/docs/ja/api/v1/people) と同じです。             |

## パラメータ

| 名前                 | 概要                                                | 使用例                     |
| ------------------ | ------------------------------------------------- | ----------------------- |
| 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 |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/casts?access_token=(access_token)&filter_ids=43414
```

```javascript
{
  "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
}
```


# GET /v1/following

Annictに登録されているユーザのフォロー情報を取得することができます。

## フィールド

[GET /v1/users](/docs/ja/api/v1/users) のフィールドと同じです。

## パラメータ

| 名前               | 概要                                                | 使用例                       |
| ---------------- | ------------------------------------------------- | ------------------------- |
| fields           | レスポンスボディに含まれるデータのフィールドを絞り込みます。                    | fields=id,username        |
| filter\_user\_id | ユーザIDで絞り込みます。                                     | filter\_user\_id=2        |
| filter\_username | ユーザ名で絞り込みます。                                      | filter\_username=shimbaco |
| page             | ページ数を指定します。                                       | page=2                    |
| per\_page        | 1ページに何件取得するかを指定します。デフォルトは `25` 件で、`50` 件まで指定できます。 | per\_page=30              |
| sort\_id         | IDで並び替えます。`asc` または `desc` が指定できます。               | sort\_id=desc             |

## リクエスト例

```
$ curl -X GET https://api.annict.com/v1/following?access_token=(access_token)&filter_username=shimbaco&per_page=2
```

```javascript
{
  "users": [
    {
      "id": 3,
      "username": "builtlast",
      "name": "岩永勇輝 (Creasty)",
      "description": "Web やってる大学生\nプログラミングとかデザインとか\n価値を生み出せるようになりたい\n\nアルバイト@FICC\n\nC / Obj-C / Ruby / Haskell / PHP / CoffeeScript / VimScript / Photoshop / Illustrator",
      "url": null,
      "avatar_url": "https://api-assets.annict.com/paperclip/profiles/2/tombo_avatars/master/cc301ca5c5e13399144c79daa4e4727b783676de.jpg?1428129519",
      "background_image_url": "https://api-assets.annict.com/paperclip/profiles/2/tombo_avatars/master/cc301ca5c5e13399144c79daa4e4727b783676de.jpg?1428129519",
      "records_count": 0,
      "created_at": "2014-03-04T09:32:25.000Z"
    },
    {
      "id": 4,
      "username": "pataiji",
      "name": "PATAIJI",
      "description": "FICC inc.ベースやってます。カブに乗ってます。AWSすごい良い。Railsすごい楽。",
      "url": null,
      "avatar_url": "https://api-assets.annict.com/paperclip/profiles/3/tombo_avatars/master/33ce537a4cf38f71b509f295f2afa3291c281dcf.jpg?1428129521",
      "background_image_url": "https://api-assets.annict.com/paperclip/profiles/3/tombo_avatars/master/33ce537a4cf38f71b509f295f2afa3291c281dcf.jpg?1428129521",
      "records_count": 0,
      "created_at": "2014-03-04T09:32:28.000Z"
    }
  ],
  "total_count": 274,
  "next_page": 2,
  "prev_page": null
}
```


# Summary

## REST API

* [概要](/docs/ja/api/v1/overview)
* [認証](/docs/ja/api/v1/authentication)
* [/v1/works](/docs/ja/api/v1/works)
* [/v1/episodes](/docs/ja/api/v1/episodes)
* [/v1/people](/docs/ja/api/v1/people)
* [/v1/organizations](/docs/ja/api/v1/organizations)
* [/v1/series](/docs/ja/api/v1/series)
* [/v1/characters](/docs/ja/api/v1/characters)
* [/v1/casts](/docs/ja/api/v1/casts)
* [/v1/staffs](/docs/ja/api/v1/staffs)
* [/v1/records](/docs/ja/api/v1/records)
* [/v1/reviews](/docs/ja/api/v1/reviews)
* [/v1/users](/docs/ja/api/v1/users)
* [/v1/following](/docs/ja/api/v1/following)
* [/v1/followers](/docs/ja/api/v1/followers)
* [/v1/activities](/docs/ja/api/v1/activities)
* [/v1/me](/docs/ja/api/v1/me)
* [/v1/me/statuses](/docs/ja/api/v1/me-statuses)
* [/v1/me/records](/docs/ja/api/v1/me-records)
* [/v1/me/reviews](/docs/ja/api/v1/me-reviews)
* [/v1/me/works](/docs/ja/api/v1/me-works)
* [/v1/me/programs](/docs/ja/api/v1/me-programs)
* [/v1/me/following\_activities](/docs/ja/api/v1/me-following-activities)


# Annict Docs (English)