# PikaNetwork

> Read public PikaNetwork Minecraft server stats through the official stats API: player profiles, per-gamemode statistics and global leaderboards (BedWars, SkyWars, Practice, KitPvP, and more), clan details, BedWars match recaps, and the live network player count. No account or API key required.

App · Gaming · 7 actions. Web page: https://docs.lodol.com/docs/integrations/pikanetwork

## Actions

### Get a clan

Look up a clan (guild) by name: its tag, trophies, level, owner, creation time, and the full member list.

**Inputs**

- Clan name (`name`, text, required): The clan's exact name (for example, Elite).

**Outputs**

- `leveling` (object)
- `members` (list)
- `name` (text)
- `owner` (object)
- `tag` (text)

**Example output**

```json
{
  "creationTime": "2022-05-22T12:51:40",
  "currentTrophies": 0,
  "leveling": {
    "exp": 22104,
    "level": 84,
    "totalExp": 6190611
  },
  "members": [
    {
      "joinDate": "2022-05-22T12:51:40",
      "user": {
        "username": "Fqch"
      }
    }
  ],
  "name": "Elite",
  "owner": {
    "username": "Fqch"
  },
  "tag": "\u2726Elite\u2726"
}
```

### Get a leaderboard

Get the global ranking of top players for one gamemode statistic. Each entry has the player's rank (place), value, username, and clan. Page through the ranking with offset and limit.

**Inputs**

- Gamemode (`gamemode`, text): Which PikaNetwork gamemode to read. Defaults to BedWars. One of: `bedwars`, `skywars`, `rankedpractice` (Practice (Ranked)), `unrankedpractice` (Practice (Unranked)), `practice` (Practice (Legacy)), `kitpvp`, `survival`, `opfactions` (OP Factions), `oneblock`, `lifesteal`, and 9 more. Default: `bedwars`.
- Statistic (`stat`, text, required): Which statistic to rank by. The choices update to match the gamemode you pick above (for example, Wins or Final kills in BedWars).
- Time window (`interval`, text): The period the statistics cover: all-time, this month, or this week. Defaults to all-time. One of: `total` (All-time), `monthly` (This month), `weekly` (This week). Default: `total`.
- Mode (`mode`, text): The sub-mode to read. 'All modes' combines every sub-mode; the Solo/Doubles/Triples/Quad splits mainly apply to team gamemodes such as BedWars and SkyWars. Defaults to all modes. One of: `ALL_MODES` (All modes), `SOLO`, `DOUBLES`, `TRIPLES`, `QUAD`. Default: `ALL_MODES`.
- Limit (`limit`, number): How many ranked players to return. Defaults to 10. From 1 to 100. Default: `10`.
- Offset (`offset`, number): How many top players to skip before returning results (for paging). Defaults to 0, start at rank 1. At least 0. Default: `0`.

**Outputs**

- `entries` (list)
- `metadata` (object)

**Example output**

```json
{
  "entries": [
    {
      "clan": "Elite",
      "id": "ohRickyy",
      "place": 1,
      "value": "13990"
    },
    {
      "clan": "ANNOY",
      "id": "_MMc",
      "place": 2,
      "value": "13278"
    },
    {
      "clan": "NEXUS",
      "id": "adriankal",
      "place": 3,
      "value": "12953"
    }
  ],
  "metadata": {
    "total": 2128223
  }
}
```

### Get a match recap

Get a BedWars match recap by its id (generated in-game with the /recap command): the map, duration, winners, and every player's per-match stats.

**Inputs**

- Recap ID (`recap_id`, text, required): The recap's id (a UUID, for example c19218da-69fc-4c27-99f6-c607c1676ac2).

**Outputs**

- `gameDuration` (text)
- `mapName` (text)
- `users` (list)
- `winners` (list)

**Example output**

```json
{
  "gameDuration": "7 minutes 5 seconds",
  "gameStart": "2024-06-14T08:10:38.300+00:00",
  "gameType": "BedWars",
  "id": "c19218da-69fc-4c27-99f6-c607c1676ac2",
  "mapName": "Lighthouse",
  "users": [
    {
      "stats": {
        "Beds destroyed": "1",
        "Deaths": "6",
        "Final kills": "3",
        "Kills": "7"
      },
      "username": "Milan_PlayzMC"
    }
  ],
  "winners": [
    "Milan_PlayzMC",
    "fwmilan"
  ]
}
```

### Get a player

Look up a player's public profile by username: their network level and progress, purchased ranks, clan, friends, and when they were last seen.

**Inputs**

- Username (`username`, text, required): The player's exact in-game Minecraft username (for example, Technoblade).

**Outputs**

- `clan` (object)
- `friends` (list)
- `lastSeen` (number)
- `rank` (object)
- `ranks` (list)
- `username` (text)

**Example output**

```json
{
  "clan": null,
  "discord_boosting": false,
  "discord_verified": false,
  "email_verified": true,
  "friends": [
    {
      "username": "iAix"
    }
  ],
  "lastSeen": 1786660981145,
  "rank": {
    "experience": 96,
    "level": 3,
    "percentage": 41.55844,
    "rankDisplay": "&7"
  },
  "ranks": [],
  "username": "Technoblade"
}
```

### Get a player's statistics

Get every tracked statistic for a player in one gamemode. For each statistic you get the player's value and their global rank (place) on the leaderboard.

**Inputs**

- Username (`username`, text, required): The player's exact in-game Minecraft username (for example, Technoblade).
- Gamemode (`gamemode`, text): Which PikaNetwork gamemode to read. Defaults to BedWars. One of: `bedwars`, `skywars`, `rankedpractice` (Practice (Ranked)), `unrankedpractice` (Practice (Unranked)), `practice` (Practice (Legacy)), `kitpvp`, `survival`, `opfactions` (OP Factions), `oneblock`, `lifesteal`, and 9 more. Default: `bedwars`.
- Time window (`interval`, text): The period the statistics cover: all-time, this month, or this week. Defaults to all-time. One of: `total` (All-time), `monthly` (This month), `weekly` (This week). Default: `total`.
- Mode (`mode`, text): The sub-mode to read. 'All modes' combines every sub-mode; the Solo/Doubles/Triples/Quad splits mainly apply to team gamemodes such as BedWars and SkyWars. Defaults to all modes. One of: `ALL_MODES` (All modes), `SOLO`, `DOUBLES`, `TRIPLES`, `QUAD`. Default: `ALL_MODES`.

**Outputs**: A map of statistic name to the player's standing ({metadata:{total}, entries:[{place, value, id}]}).

**Example output**

```json
{
  "Final kills": {
    "entries": [
      {
        "id": "Technoblade",
        "place": 1058672,
        "value": "8"
      }
    ],
    "metadata": {
      "total": 2968169
    }
  },
  "Kills": {
    "entries": [
      {
        "id": "Technoblade",
        "place": 1153012,
        "value": "32"
      }
    ],
    "metadata": {
      "total": 4373583
    }
  },
  "Wins": {
    "entries": [
      {
        "id": "Technoblade",
        "place": 1735601,
        "value": "1"
      }
    ],
    "metadata": {
      "total": 2128223
    }
  }
}
```

### Get gamemode totals

Get network-wide aggregate figures for every statistic in a gamemode: how many players are counted, the average per player, and the grand total.

**Inputs**

- Gamemode (`gamemode`, text): Which PikaNetwork gamemode to read. Defaults to BedWars. One of: `bedwars`, `skywars`, `rankedpractice` (Practice (Ranked)), `unrankedpractice` (Practice (Unranked)), `practice` (Practice (Legacy)), `kitpvp`, `survival`, `opfactions` (OP Factions), `oneblock`, `lifesteal`, and 9 more. Default: `bedwars`.

**Outputs**: One entry per statistic: {name, total, average, sum}.

**Example output**

```json
[
  {
    "average": 136.04,
    "name": "Kills",
    "sum": 593461529.0,
    "total": 4362548.0
  },
  {
    "average": 21.66,
    "name": "Wins",
    "sum": 45998681.0,
    "total": 2123826.0
  }
]
```

### Get live player count

Get PikaNetwork's current live player count and Discord member count right now.

**Inputs**: None.

**Outputs**

- `count` (number)
- `discordCount` (number)
- `ip` (text)
- `updated_at` (text)

**Example output**

```json
{
  "count": 1177,
  "discordCount": 5664,
  "ip": "play.pika-network.net",
  "updated_at": "2026-08-14T01:09:45.714Z"
}
```
