Skip to main content
GET
/
broodmares
繁殖馬一覧
curl --request GET \
  --url https://api.beter-keiba.com/v1/broodmares \
  --header 'Authorization: Bearer <token>'
{
  "code": "SUCCESS",
  "data": [
    {
      "id": "hn_1234567890",
      "dataType": "2",
      "dataUpdatedAt": 1716715200,
      "horseId": "um_2021105477",
      "name": "トップデサイル",
      "nameKana": "トップデサイル",
      "nameEng": "Top Decile",
      "birthYear": 2010,
      "sexCode": "1",
      "breedCode": "1",
      "colorCode": "03",
      "importTypeCode": "3",
      "importYear": 0,
      "originName": "アメリカ",
      "sireBroodmareId": "hn_1234567890",
      "damBroodmareId": "hn_1234567890",
      "createdAt": 1716716000,
      "updatedAt": 1716716000
    }
  ],
  "extensions": {
    "totalCount": 1,
    "limit": 50,
    "page": 1,
    "totalPages": 1,
    "dataUpdatedAt": 1716715200
  }
}

Authorizations

Authorization
string
header
required

APIダッシュボードで発行された sk_live_... または sk_test_... キーを入力してください。prefix は mode を示し、両 mode とも同じ API URL で利用できます (sk_live_* = live mode / 本番、sk_test_* = test mode / 開発・自動テスト)。

Query Parameters

q
string

名前で絞り込み

Maximum string length: 200
sort
string

ソート順(- を付けると降順)

Maximum string length: 100
fields
string

取得するフィールドの絞り込み(カンマ区切り)

Maximum string length: 500
page
integer
default:1

ページ番号 (1 以上 10000 以下)

Required range: 1 <= x <= 10000
limit
integer
default:100

1リクエストあたりの最大取得件数 (1 以上 1000 以下)

Required range: 1 <= x <= 1000

Response

Success

成功レスポンスの共通ラッパー。code は常に "SUCCESS"、data にエンドポイント固有のレスポンスボディ、extensions に補助情報 (pagination や統計など) を含みます。

code
string
required

処理結果コード。成功時は常に 'SUCCESS'

Example:

"SUCCESS"

data
object[]
required

取得されたデータ本体

extensions
object

レスポンスに関する補助情報(メタデータ)。一覧取得時にはページネーション情報が含まれます。