# Sumo API

> Look up professional sumo with Sumo API: search wrestlers and read their profiles and career records, get every bout they have fought and their record against any opponent, pull a tournament's championship and prize winners, a division's banzuke and any day's torikumi, and browse the winning techniques bouts are decided by. Uses the keyless public API. No account or API key required.

App · Sports · 14 actions. Web page: https://docs.lodol.com/docs/integrations/sumo-api

## Actions

### Get a day's bouts (torikumi)

Get the torikumi (every bout in one division on one day of a tournament) with both wrestlers, their ranks, the winner and the technique it was won by. No API key required.

**Inputs**

- Tournament (`basho_id`, text, required): The tournament, as a year and month run together: 202303 is the March 2023 tournament. '2023-03' and a full date such as '2023-03-12' also work. Grand tournaments are held in January, March, May, July, September and November.
- Division (`division`, text, required): Which division to read, from Makuuchi at the top of the banzuke down to Jonokuchi at the bottom. One of: `Makuuchi` (Makuuchi (top division)), `Juryo` (Juryo (second division, salaried)), `Makushita` (Makushita (third division)), `Sandanme` (Sandanme (fourth division)), `Jonidan` (Jonidan (fifth division)), `Jonokuchi` (Jonokuchi (entry division)). Default: `Makuuchi`.
- Day (`day`, number, required): Which day of the tournament, 1 to 15. When a tournament ends level, the playoff bouts are recorded past day 15. From 1 to 20. Default: `1`.

**Outputs**

- `basho_id` (text): The same id, under a stable key.
- `basho_month` (number): The month it was held, 1-12.
- `basho_month_name` (text): That month's English name.
- `basho_name` (text): The tournament's name, from the month it is held in (Hatsu, Haru, Natsu, Nagoya, Aki or Kyushu).
- `basho_year` (number): The year it was held.
- `count` (number): How many bouts were fought.
- `date` (text): The tournament id, as YYYYMM.
- `day` (number): The day they were fought.
- `division` (text): The division these bouts are from.
- `endDate` (text): When it finished.
- `location` (text): Where it was held.
- `matches` (list): The same bouts, under the name other actions use.
- `special_prizes` (list): The special prizes awarded (Shukun-sho, Kanto-sho, Gino-sho).
- `startDate` (text): When it started.
- `torikumi` (list): The day's bouts, in the order they were fought.
- `yusho` (list): The championship winner of each division.

**Example output**

```json
{
  "basho_id": "202303",
  "basho_month": 3,
  "basho_month_name": "March",
  "basho_name": "Haru Basho",
  "basho_year": 2023,
  "count": 1,
  "date": "202303",
  "day": 14,
  "division": "Makuuchi",
  "endDate": "2023-03-26T00:00:00Z",
  "location": "Osaka",
  "matches": [
    {
      "bashoId": "202303",
      "day": 14,
      "division": "Makuuchi",
      "eastId": 45,
      "eastRank": "Yokozuna 1 East",
      "eastShikona": "Terunofuji",
      "east_won": true,
      "kimarite": "yorikiri",
      "loser_id": 12,
      "loser_shikona": "Takakeisho",
      "matchNo": 20,
      "westId": 12,
      "westRank": "Ozeki 1 West",
      "westShikona": "Takakeisho",
      "winnerEn": "Terunofuji",
      "winnerId": 45,
      "winner_shikona": "Terunofuji"
    }
  ],
  "special_prizes": [
    {
      "rikishiId": 12,
      "shikonaEn": "Kiribayama",
      "shikonaJp": "\u9727\u99ac\u5c71",
      "type": "Shukun-sho"
    }
  ],
  "startDate": "2023-03-12T00:00:00Z",
  "torikumi": [
    {
      "bashoId": "202303",
      "day": 14,
      "division": "Makuuchi",
      "eastId": 45,
      "eastRank": "Yokozuna 1 East",
      "eastShikona": "Terunofuji",
      "east_won": true,
      "kimarite": "yorikiri",
      "loser_id": 12,
      "loser_shikona": "Takakeisho",
      "matchNo": 20,
      "westId": 12,
      "westRank": "Ozeki 1 West",
      "westShikona": "Takakeisho",
      "winnerEn": "Terunofuji",
      "winnerId": 45,
      "winner_shikona": "Terunofuji"
    }
  ],
  "yusho": [
    {
      "rikishiId": 12,
      "shikonaEn": "Kiribayama",
      "shikonaJp": "\u9727\u99ac\u5c71",
      "type": "Makuuchi"
    }
  ]
}
```

### Get a division's rankings (banzuke)

Get the banzuke (the official ranking sheet) for one division at one tournament, with each wrestler's rank, side and win/loss record. East and west come back separately, as the sheet is drawn, plus one combined list in ranking order. No API key required.

**Inputs**

- Tournament (`basho_id`, text, required): The tournament, as a year and month run together: 202303 is the March 2023 tournament. '2023-03' and a full date such as '2023-03-12' also work. Grand tournaments are held in January, March, May, July, September and November.
- Division (`division`, text, required): Which division to read, from Makuuchi at the top of the banzuke down to Jonokuchi at the bottom. One of: `Makuuchi` (Makuuchi (top division)), `Juryo` (Juryo (second division, salaried)), `Makushita` (Makushita (third division)), `Sandanme` (Sandanme (fourth division)), `Jonidan` (Jonidan (fifth division)), `Jonokuchi` (Jonokuchi (entry division)). Default: `Makuuchi`.

**Outputs**

- `basho_id` (text): The tournament this banzuke is for.
- `count` (number): How many wrestlers are on the banzuke.
- `division` (text): The division this banzuke is for.
- `east` (list): The east side of the sheet.
- `west` (list): The west side of the sheet.
- `wrestlers` (list): Everyone on the banzuke, highest rank first, east and west combined.

**Example output**

```json
{
  "basho_id": "202303",
  "count": 1,
  "division": "Makuuchi",
  "east": [
    {
      "absences": 0,
      "losses": 4,
      "rank": "Yokozuna 1 East",
      "rankValue": 101,
      "record": [],
      "rikishiID": 45,
      "rikishi_id": 45,
      "shikonaEn": "Terunofuji",
      "side": "East",
      "wins": 11
    }
  ],
  "west": [],
  "wrestlers": [
    {
      "absences": 0,
      "losses": 4,
      "rank": "Yokozuna 1 East",
      "rankValue": 101,
      "record": [],
      "rikishiID": 45,
      "rikishi_id": 45,
      "shikonaEn": "Terunofuji",
      "side": "East",
      "wins": 11
    }
  ]
}
```

### Get a head-to-head record

Get the record between two wrestlers: how many bouts each has won, the techniques they won them by, and every bout they have fought. No API key required.

**Inputs**

- Wrestler ID (`rikishi_id`, number, required): The wrestler's Sumo API id, as returned by 'Search wrestlers'. This is the API's own id, not a SumoDB or NSK number. At least 1.
- Opponent ID (`opponent_id`, number, required): The other wrestler's Sumo API id. At least 1.
- Tournament (`basho_id`, text): Optional. Narrow the results to one tournament, as a year and month run together: 202303 is the March 2023 tournament. Leave empty for every tournament.

**Outputs**

- `basho_id` (text): The tournament the bouts were filtered to, if any.
- `count` (number): How many bouts this response holds.
- `kimariteLosses` (object): The techniques the first wrestler's losses came by, counted.
- `kimariteWins` (object): The techniques the first wrestler's wins came by, counted.
- `losses_in_result` (number): Bouts in this response the first wrestler lost.
- `matches` (list): Every bout the two have fought.
- `opponent_id` (number): The second wrestler's id.
- `opponent_wins` (number): Bouts won by the second wrestler.
- `rikishi_id` (number): The first wrestler's id.
- `rikishi_wins` (number): Bouts won by the first wrestler.
- `total` (number): How many bouts they have fought in total.
- `wins_in_result` (number): Bouts in this response the first wrestler won, the same as the total unless a tournament filter was used.

**Example output**

```json
{
  "basho_id": null,
  "count": 1,
  "kimariteLosses": {
    "hatakikomi": 5,
    "tsukiotoshi": 5
  },
  "kimariteWins": {
    "oshidashi": 6,
    "yorikiri": 8
  },
  "losses_in_result": 0,
  "matches": [
    {
      "bashoId": "202303",
      "day": 14,
      "division": "Makuuchi",
      "eastId": 45,
      "eastRank": "Yokozuna 1 East",
      "eastShikona": "Terunofuji",
      "east_won": true,
      "kimarite": "yorikiri",
      "loser_id": 12,
      "loser_shikona": "Takakeisho",
      "matchNo": 20,
      "westId": 12,
      "westRank": "Ozeki 1 West",
      "westShikona": "Takakeisho",
      "winnerEn": "Terunofuji",
      "winnerId": 45,
      "winner_shikona": "Terunofuji"
    }
  ],
  "opponent_id": 12,
  "opponent_wins": 10,
  "rikishi_id": 45,
  "rikishi_wins": 14,
  "total": 24,
  "wins_in_result": 1
}
```

### Get a tournament

Get one tournament: when and where it was held, who won each division's championship (yusho) and who took the special prizes (sansho). No API key required.

**Inputs**

- Tournament (`basho_id`, text, required): The tournament, as a year and month run together: 202303 is the March 2023 tournament. '2023-03' and a full date such as '2023-03-12' also work. Grand tournaments are held in January, March, May, July, September and November.

**Outputs**

- `basho_id` (text): The same id, under a stable key.
- `basho_month` (number): The month it was held, 1-12.
- `basho_month_name` (text): That month's English name.
- `basho_name` (text): The tournament's name, from the month it is held in (Hatsu, Haru, Natsu, Nagoya, Aki or Kyushu).
- `basho_year` (number): The year it was held.
- `date` (text): The tournament id, as YYYYMM.
- `endDate` (text): When it finished.
- `location` (text): Where it was held.
- `special_prizes` (list): The special prizes awarded (Shukun-sho, Kanto-sho, Gino-sho).
- `startDate` (text): When it started.
- `yusho` (list): The championship winner of each division.

**Example output**

```json
{
  "basho_id": "202303",
  "basho_month": 3,
  "basho_month_name": "March",
  "basho_name": "Haru Basho",
  "basho_year": 2023,
  "date": "202303",
  "endDate": "2023-03-26T00:00:00Z",
  "location": "Osaka",
  "special_prizes": [
    {
      "rikishiId": 12,
      "shikonaEn": "Kiribayama",
      "shikonaJp": "\u9727\u99ac\u5c71",
      "type": "Shukun-sho"
    }
  ],
  "startDate": "2023-03-12T00:00:00Z",
  "yusho": [
    {
      "rikishiId": 12,
      "shikonaEn": "Kiribayama",
      "shikonaJp": "\u9727\u99ac\u5c71",
      "type": "Makuuchi"
    }
  ]
}
```

### Get a wrestler

Get one wrestler's profile: ring name, stable, rank, height, weight, where they are from and when they debuted, optionally with how their measurements, ranks and ring names have changed over their career. No API key required.

**Inputs**

- Wrestler ID (`rikishi_id`, number, required): The wrestler's Sumo API id, as returned by 'Search wrestlers'. This is the API's own id, not a SumoDB or NSK number. At least 1.
- Include measurement history (`include_measurements`, true/false): Include how the wrestler's height and weight have changed over their career. Default: `false`.
- Include rank history (`include_ranks`, true/false): Include the wrestler's rank at every tournament they appeared in. Default: `false`.
- Include ring-name history (`include_shikonas`, true/false): Include every shikona (ring name) the wrestler has competed under. Default: `false`.
- History order (`sort_order`, text): Order of the measurement, rank and shikona history included above, by tournament. Has no effect unless one of those is switched on. One of: `desc` (Descending: most recent first), `asc` (Ascending: oldest first). Default: `desc`.

**Outputs**

- `birthDate` (text): Date of birth.
- `currentRank` (text): Their rank on the current banzuke, e.g. 'Yokozuna 1 East'.
- `debut` (text): The tournament they debuted at, as YYYYMM.
- `height` (number): Height in centimetres.
- `heya` (text): The stable they belong to.
- `id` (number): The wrestler's Sumo API id, which every other action takes.
- `intai` (text): Retirement date. Absent while they are still competing.
- `is_active` (true/false): True when no retirement date is recorded.
- `nskId` (number): The wrestler's official id with the Japan Sumo Association (NSK).
- `shikonaEn` (text): The wrestler's ring name in the Latin alphabet.
- `shikonaJp` (text): The same ring name in Japanese.
- `shusshin` (text): Where they are from.
- `sumodbId` (number): The wrestler's id in the SumoDB database, when known.
- `weight` (number): Weight in kilograms.

**Example output**

```json
{
  "birthDate": "1991-11-29T00:00:00Z",
  "currentRank": "Yokozuna 1 East",
  "debut": "201101",
  "height": 192,
  "heya": "Isegahama",
  "id": 45,
  "intai": null,
  "is_active": true,
  "nskId": 3321,
  "shikonaEn": "Terunofuji Haruo",
  "shikonaJp": "\u7167\u30ce\u5bcc\u58eb \u6625\u96c4",
  "shusshin": "Mongolia, Ulaanbaatar",
  "sumodbId": 11927,
  "weight": 184
}
```

### Get a wrestler's bouts

Get every bout a wrestler has fought, most recent tournament first, with the opponent, the rank each held and the technique the bout was won by. Narrow it to a single tournament to get one basho's results. No API key required.

**Inputs**

- Wrestler ID (`rikishi_id`, number, required): The wrestler's Sumo API id, as returned by 'Search wrestlers'. This is the API's own id, not a SumoDB or NSK number. At least 1.
- Tournament (`basho_id`, text): Optional. Narrow the results to one tournament, as a year and month run together: 202303 is the March 2023 tournament. Leave empty for every tournament.

**Outputs**

- `basho_id` (text): The tournament these results were filtered to, if any.
- `count` (number): How many results this response holds.
- `has_more` (true/false): True when further results are waiting past this page.
- `limit` (number): The page size that was used.
- `matches` (list): The bouts, most recent first.
- `rikishi_id` (number): The wrestler these results were filtered to, if any.
- `skip` (number): How many results were skipped before this page.
- `total` (number): How many results match in total, across all pages.

**Example output**

```json
{
  "basho_id": "202303",
  "count": 1,
  "has_more": false,
  "limit": null,
  "matches": [
    {
      "bashoId": "202303",
      "day": 14,
      "division": "Makuuchi",
      "eastId": 45,
      "eastRank": "Yokozuna 1 East",
      "eastShikona": "Terunofuji",
      "east_won": true,
      "kimarite": "yorikiri",
      "loser_id": 12,
      "loser_shikona": "Takakeisho",
      "matchNo": 20,
      "westId": 12,
      "westRank": "Ozeki 1 West",
      "westShikona": "Takakeisho",
      "winnerEn": "Terunofuji",
      "winnerId": 45,
      "winner_shikona": "Terunofuji"
    }
  ],
  "rikishi_id": 45,
  "skip": 0,
  "total": 1
}
```

### Get a wrestler's career record

Get a wrestler's career totals: tournaments fought, bouts won and lost, absences, championships (yusho) and special prizes (sansho), broken down by division. No API key required.

**Inputs**

- Wrestler ID (`rikishi_id`, number, required): The wrestler's Sumo API id, as returned by 'Search wrestlers'. This is the API's own id, not a SumoDB or NSK number. At least 1.

**Outputs**

- `absenceByDivision` (object): Absences, counted per division.
- `basho` (number): How many tournaments they have fought in.
- `bashoByDivision` (object): Tournaments fought, counted per division.
- `lossByDivision` (object): Bouts lost, counted per division.
- `rikishi_id` (number): The wrestler these totals are for.
- `sansho` (object): Special prizes won, counted by prize (Shukun-sho, Kanto-sho, Gino-sho).
- `totalAbsences` (number): Bouts missed through absence.
- `totalByDivision` (object): Bouts fought, counted per division.
- `totalLosses` (number): Bouts lost.
- `totalMatches` (number): Bouts fought across their career.
- `totalWins` (number): Bouts won.
- `winsByDivision` (object): Bouts won, counted per division.
- `yusho` (number): Tournament championships won.
- `yushoByDivision` (object): Those championships, counted per division.

**Example output**

```json
{
  "absenceByDivision": {
    "Juryo": 0,
    "Makuuchi": 20
  },
  "basho": 62,
  "bashoByDivision": {
    "Juryo": 8,
    "Makuuchi": 45
  },
  "lossByDivision": {
    "Juryo": 30,
    "Makuuchi": 180
  },
  "rikishi_id": 45,
  "sansho": {
    "Gino-sho": 2,
    "Kanto-sho": 3,
    "Shukun-sho": 4
  },
  "totalAbsences": 21,
  "totalByDivision": {
    "Juryo": 90,
    "Makuuchi": 540
  },
  "totalLosses": 244,
  "totalMatches": 712,
  "totalWins": 447,
  "winsByDivision": {
    "Juryo": 60,
    "Makuuchi": 340
  },
  "yusho": 9,
  "yushoByDivision": {
    "Juryo": 1,
    "Makuuchi": 8
  }
}
```

### Get bouts won by a technique

Get the bouts a given winning technique decided: every yorikiri, or every rare technique you want examples of. No API key required.

**Inputs**

- Technique (`kimarite`, text, required): The winning technique to look up, e.g. 'yorikiri' (force out) or 'uwatenage' (overarm throw).
- Order (`sort_order`, text): Order the bouts by tournament, oldest or newest first. One of: `desc` (Descending: most recent first), `asc` (Ascending: oldest first). Default: `asc`.
- Maximum results (`limit`, number): How many bouts to return. The API allows at most 1000 per request; use 'Skip' to page through more. From 1 to 1000. Default: `20`.
- Skip (`skip`, number): How many results to skip before returning any: page two of a 20-result page starts at 20. At least 0.

**Outputs**

- `count` (number): How many results this response holds.
- `has_more` (true/false): True when further results are waiting past this page.
- `kimarite` (text): The technique these bouts were won by.
- `limit` (number): The page size that was used.
- `matches` (list): The bouts this technique decided.
- `skip` (number): How many results were skipped before this page.
- `total` (number): How many results match in total, across all pages.

**Example output**

```json
{
  "count": 1,
  "has_more": true,
  "kimarite": "yorikiri",
  "limit": 20,
  "matches": [
    {
      "bashoId": "202303",
      "day": 14,
      "division": "Makuuchi",
      "eastId": 45,
      "eastRank": "Yokozuna 1 East",
      "eastShikona": "Terunofuji",
      "east_won": true,
      "kimarite": "yorikiri",
      "loser_id": 12,
      "loser_shikona": "Takakeisho",
      "matchNo": 20,
      "westId": 12,
      "westRank": "Ozeki 1 West",
      "westShikona": "Takakeisho",
      "winnerEn": "Terunofuji",
      "winnerId": 45,
      "winner_shikona": "Terunofuji"
    }
  ],
  "skip": 0,
  "total": 234567
}
```

### Get head-to-head records in bulk

Get several head-to-head records in one request: one entry per pair of wrestlers, each returned under a label you choose. Use this instead of a step per pairing when comparing a whole field. No API key required.

**Inputs**

- Pairings (`matchups`, list, required): The pairs of wrestlers to compare. Each entry is either an object like {"key": "terunofuji-vs-takakeisho", "ids": [45, 12]} or just the two ids, as [45, 12] or "45-12". Without a key, a pairing is labelled '<first>-<second>'.
- Maximum results (`limit`, number): How many bouts per pairing to return. The API allows at most 1000 per request; use 'Skip' to page through more. From 1 to 1000.
- Skip (`skip`, number): How many bouts to skip in each pairing before returning any. At least 0.
- Order (`sort_order`, text): Order the bouts in each pairing by tournament, newest or oldest first. One of: `desc` (Descending: most recent first), `asc` (Ascending: oldest first).

**Outputs**

- `count` (number): How many pairings came back.
- `keys` (list): The labels the records are keyed by.
- `matchups` (list): The pairings exactly as they were requested.
- `results` (object): One head-to-head record per pairing, keyed by the pairing's label.

**Example output**

```json
{
  "count": 1,
  "keys": [
    "45-12"
  ],
  "matchups": [
    {
      "ids": [
        45,
        12
      ],
      "key": "45-12"
    }
  ],
  "results": {
    "45-12": {
      "count": 1,
      "matches": [
        {
          "bashoId": "202303",
          "day": 14,
          "division": "Makuuchi",
          "eastId": 45,
          "eastRank": "Yokozuna 1 East",
          "eastShikona": "Terunofuji",
          "east_won": true,
          "kimarite": "yorikiri",
          "loser_id": 12,
          "loser_shikona": "Takakeisho",
          "matchNo": 20,
          "westId": 12,
          "westRank": "Ozeki 1 West",
          "westShikona": "Takakeisho",
          "winnerEn": "Terunofuji",
          "winnerId": 45,
          "winner_shikona": "Terunofuji"
        }
      ],
      "opponent_id": 12,
      "opponent_wins": 10,
      "rikishi_id": 45,
      "rikishi_wins": 14,
      "total": 24
    }
  }
}
```

### Get measurement changes

Get recorded changes in height and weight, either one wrestler's over their career, or everyone's at one tournament. No API key required.

**Inputs**

- Wrestler ID (`rikishi_id`, number): The wrestler whose changes to return. Give this or a tournament, not both. At least 1.
- Tournament (`basho_id`, text): The tournament whose changes to return, as a year and month run together (202301). Give this or a wrestler, not both.
- Order (`sort_order`, text): Order the results by tournament, newest or oldest first. One of: `desc` (Descending: most recent first), `asc` (Ascending: oldest first). Default: `desc`.
- Maximum results (`limit`, number): How many records to return. The API allows at most 1000 per request; use 'Skip' to page through more. From 1 to 1000.
- Skip (`skip`, number): How many results to skip before returning any: page two of a 20-result page starts at 20. At least 0.

**Outputs**

- `basho_id` (text): The tournament these results were filtered to, if any.
- `count` (number): How many results this response holds.
- `has_more` (true/false): True when further results are waiting past this page.
- `limit` (number): The page size that was used.
- `measurements` (list): The measurement records, by tournament.
- `rikishi_id` (number): The wrestler these results were filtered to, if any.
- `skip` (number): How many results were skipped before this page.
- `total` (number): How many results match in total, across all pages.

**Example output**

```json
{
  "basho_id": null,
  "count": 1,
  "has_more": false,
  "limit": null,
  "measurements": [
    {
      "bashoId": "202303",
      "height": 192,
      "id": "202303-45",
      "rikishiId": 45,
      "weight": 184
    }
  ],
  "rikishi_id": 45,
  "skip": 0,
  "total": 1
}
```

### Get rank changes

Get recorded rank changes, either one wrestler's climb and fall down the banzuke, or every rank recorded at one tournament. No API key required.

**Inputs**

- Wrestler ID (`rikishi_id`, number): The wrestler whose changes to return. Give this or a tournament, not both. At least 1.
- Tournament (`basho_id`, text): The tournament whose changes to return, as a year and month run together (202301). Give this or a wrestler, not both.
- Order (`sort_order`, text): Order the results by tournament, newest or oldest first. One of: `desc` (Descending: most recent first), `asc` (Ascending: oldest first). Default: `desc`.
- Maximum results (`limit`, number): How many records to return. The API allows at most 1000 per request; use 'Skip' to page through more. From 1 to 1000.
- Skip (`skip`, number): How many results to skip before returning any: page two of a 20-result page starts at 20. At least 0.

**Outputs**

- `basho_id` (text): The tournament these results were filtered to, if any.
- `count` (number): How many results this response holds.
- `has_more` (true/false): True when further results are waiting past this page.
- `limit` (number): The page size that was used.
- `ranks` (list): The rank records, by tournament.
- `rikishi_id` (number): The wrestler these results were filtered to, if any.
- `skip` (number): How many results were skipped before this page.
- `total` (number): How many results match in total, across all pages.

**Example output**

```json
{
  "basho_id": null,
  "count": 1,
  "has_more": false,
  "limit": null,
  "ranks": [
    {
      "bashoId": "202303",
      "id": "202303-45",
      "rank": "Yokozuna 1 East",
      "rankValue": 101,
      "rikishiId": 45
    }
  ],
  "rikishi_id": 45,
  "skip": 0,
  "total": 1
}
```

### Get ring-name changes

Get recorded shikona (ring name) changes, either every name one wrestler has competed under, or every name change recorded at one tournament. No API key required.

**Inputs**

- Wrestler ID (`rikishi_id`, number): The wrestler whose changes to return. Give this or a tournament, not both. At least 1.
- Tournament (`basho_id`, text): The tournament whose changes to return, as a year and month run together (202301). Give this or a wrestler, not both.
- Order (`sort_order`, text): Order the results by tournament, newest or oldest first. One of: `desc` (Descending: most recent first), `asc` (Ascending: oldest first). Default: `desc`.
- Maximum results (`limit`, number): How many records to return. The API allows at most 1000 per request; use 'Skip' to page through more. From 1 to 1000.
- Skip (`skip`, number): How many results to skip before returning any: page two of a 20-result page starts at 20. At least 0.

**Outputs**

- `basho_id` (text): The tournament these results were filtered to, if any.
- `count` (number): How many results this response holds.
- `has_more` (true/false): True when further results are waiting past this page.
- `limit` (number): The page size that was used.
- `rikishi_id` (number): The wrestler these results were filtered to, if any.
- `shikonas` (list): The ring-name records, by tournament.
- `skip` (number): How many results were skipped before this page.
- `total` (number): How many results match in total, across all pages.

**Example output**

```json
{
  "basho_id": null,
  "count": 1,
  "has_more": false,
  "limit": null,
  "rikishi_id": 45,
  "shikonas": [
    {
      "bashoId": "202303",
      "id": "202303-45",
      "rikishiId": 45,
      "shikonaEn": "Terunofuji Haruo",
      "shikonaJp": "\u7167\u30ce\u5bcc\u58eb \u6625\u96c4"
    }
  ],
  "skip": 0,
  "total": 1
}
```

### List winning techniques

List the kimarite (the winning techniques a bout can be decided by), with how many recorded bouts each has decided and when it was last used. No API key required.

**Inputs**

- Sort by (`sort_field`, text): Which column to order the techniques by. One of: `count` (How often the technique has been used), `kimarite` (Technique name (alphabetical)), `lastUsage` (When the technique was last used). Default: `count`.
- Order (`sort_order`, text): Whether to sort ascending or descending. One of: `desc` (Descending: most recent first), `asc` (Ascending: oldest first). Default: `asc`.
- Maximum results (`limit`, number): How many techniques to return. The API allows at most 1000 per request; use 'Skip' to page through more. From 1 to 1000.
- Skip (`skip`, number): How many results to skip before returning any: page two of a 20-result page starts at 20. At least 0.

**Outputs**

- `count` (number): How many results this response holds.
- `has_more` (true/false): True when further results are waiting past this page.
- `kimarite` (list): The winning techniques and how often each is used.
- `limit` (number): The page size that was used.
- `skip` (number): How many results were skipped before this page.
- `total` (number): How many results match in total, across all pages.

**Example output**

```json
{
  "count": 1,
  "has_more": true,
  "kimarite": [
    {
      "count": 234567,
      "kimarite": "yorikiri",
      "lastUsage": "202305-11",
      "last_basho_id": "202305",
      "last_day": 11
    }
  ],
  "limit": 1,
  "skip": 0,
  "total": 82
}
```

### Search wrestlers

Find sumo wrestlers by ring name, stable or database id, and get the wrestler id every other action takes. Searches currently active wrestlers unless retired ones are included. No API key required.

**Inputs**

- Ring name (`shikona_en`, text): Search by shikona (ring name) in the Latin alphabet, e.g. 'Terunofuji'.
- Stable (`heya`, text): Only include wrestlers from this heya (stable), by its full English name.
- SumoDB ID (`sumodb_id`, number): Find the wrestler with this id in the SumoDB database, e.g. 11927 for Terunofuji. At least 1.
- NSK ID (`nsk_id`, number): Find the wrestler with this official Japan Sumo Association id, e.g. 3321 for Terunofuji. At least 1.
- Include retired wrestlers (`include_retired`, true/false): Search retired wrestlers as well as active ones. Off by default, which is why a search for a past champion can come back empty. Default: `false`.
- Include measurement history (`include_measurements`, true/false): Include how the wrestler's height and weight have changed over their career. Default: `false`.
- Include rank history (`include_ranks`, true/false): Include the wrestler's rank at every tournament they appeared in. Default: `false`.
- Include ring-name history (`include_shikonas`, true/false): Include every shikona (ring name) the wrestler has competed under. Default: `false`.
- History order (`sort_order`, text): Order of the measurement, rank and shikona history included above, by tournament. Has no effect unless one of those is switched on. One of: `desc` (Descending: most recent first), `asc` (Ascending: oldest first). Default: `desc`.
- Maximum results (`limit`, number): How many wrestlers to return. The API allows at most 1000 per request; use 'Skip' to page through more. From 1 to 1000. Default: `20`.
- Skip (`skip`, number): How many results to skip before returning any: page two of a 20-result page starts at 20. At least 0.

**Outputs**

- `count` (number): How many results this response holds.
- `has_more` (true/false): True when further results are waiting past this page.
- `limit` (number): The page size that was used.
- `rikishi` (list): The wrestlers that matched.
- `skip` (number): How many results were skipped before this page.
- `total` (number): How many results match in total, across all pages.

**Example output**

```json
{
  "count": 1,
  "has_more": false,
  "limit": 20,
  "rikishi": [
    {
      "birthDate": "1991-11-29T00:00:00Z",
      "currentRank": "Yokozuna 1 East",
      "debut": "201101",
      "height": 192,
      "heya": "Isegahama",
      "id": 45,
      "intai": null,
      "is_active": true,
      "nskId": 3321,
      "shikonaEn": "Terunofuji Haruo",
      "shikonaJp": "\u7167\u30ce\u5bcc\u58eb \u6625\u96c4",
      "shusshin": "Mongolia, Ulaanbaatar",
      "sumodbId": 11927,
      "weight": 184
    }
  ],
  "skip": 0,
  "total": 1
}
```