本ドキュメントは、RankArchiveに外部システムからアクセスするための REST API仕様 を定義したものです
https://rankarchive.jp/
本APIは GET のみを使用します
現在、認証は必要ありません
{
"status": "success", // "success" または "error"
"message": "OK", // エラー時はエラーメッセージ
"data": { ... } // 取得データ
}
| コード | 説明 |
|---|---|
| 200 | 正常終了 |
| 400 | 必須パラメータ不足などのリクエスト不正 |
| 404 | 指定条件に一致するデータが存在しない |
| 500 | サーバ内部エラー |
指定したカテゴリ・日付におけるランキング情報を取得します
カテゴリや日付によってはデータが存在しない場合があり、その場合はエラーとして扱います
| 名前 | 必須 | 型 / 例 | 説明 / デフォルト |
|---|---|---|---|
| bc | 必須 |
文字列(日本語)
例: 同人
|
大カテゴリ名。未指定の場合はエラー |
| mc | 任意 |
文字列(日本語)
例: 同人誌(男性向け)
|
中カテゴリ名 |
| sc | 任意 |
文字列(日本語)
例: パロディ系
|
小カテゴリ名 |
| date | 任意 |
日付 (YYYY-MM-DD)
例: 2025-11-13
|
ランキング取得対象の日付。 未指定時は「本日」のデータを取得します |
| sort | 任意 |
数値
1, 2, 3, 4, 5
|
並び順指定。未指定の場合は 1。 1: 順位 2: 価格高い順 3: 価格安い順 4: 前回比上昇順 5: 前回比下降順 |
| count | 任意 |
数値
1〜100
|
指定日付を基準として取得する件数 未指定時は 20、最大 100 件まで |
GET /api/ranking?bc=%E5%90%8C%E4%BA%BA%E8%AA%8C&mc=%E7%94%B7%E6%80%A7%E5%90%91%E3%81%91&date=2025-11-12&sort=1&count=20 HTTP/1.1
商品ID を指定して該当商品の詳細情報を取得します
指定された ID の商品データが存在しない場合はエラーとなります
ID に関しては、当サイトの/product/:pidを確認してください
| 名前 | 必須 | 型 / 例 | 説明 |
|---|---|---|---|
| pid | 必須 |
数値
例: 2013
|
商品ID。未指定の場合はエラー 指定された ID のデータが存在しない場合もエラー |
GET /api/product?pid=2013 HTTP/1.1
指定した商品IDについて、指定日付から指定回数分の価格履歴(過去)を取得します
指定された ID のデータが存在しない場合はエラーとなります
| 名前 | 必須 | 型 / 例 | 説明 / デフォルト |
|---|---|---|---|
| pid | 必須 |
数値
例: 2013
|
商品ID。未指定の場合はエラー 指定された ID のデータが存在しない場合もエラー |
| date | 任意 |
日付 (YYYY-MM-DD)
例: 2025-11-12
|
履歴取得の基準日 未指定時は「本日」が基準日となります |
| count | 任意 |
数値
1〜100
|
指定日付を基準として取得する履歴件数 未指定時は 30、最大 100 件まで |
GET /api/history?pid=2013&date=2025-11-12&count=30 HTTP/1.1