postman.skymavis.com Open in urlscan Pro
54.84.20.155  Public Scan

URL: https://postman.skymavis.com/
Submission: On October 12 via automatic, source certstream-suspicious — Scanned from DE

Form analysis 0 forms found in the DOM

Text Content

Public


Documentation Settings
Environment
No Environment
Layout
Double Column
Language
cURL



SKY MAVIS PUBLIC API DOCUMENT

 * Introduction


Origin's API
Sky Mavis Public API Document



Origin's API



Item


GET

List All Runes

https://game-api-origin.skymavis.com/v2/community/runes
HEADERS
X-API-Key
1f598d83-f554-4856-b7f3-cfa8b67f4be1

We will add a custom rate-limit by API Key.

PARAMS
limit
1
offset
0


Example Request
List All Rune

curl --location --request GET 'https://game-api-origin.skymavis.com/v2/community/runes' \
--header 'X-API-Key: 1f598d83-f554-4856-b7f3-cfa8b67f4be1'

Example Response
200 OK
Body
Header(6)
View More

{
  "_etag": "e10c6b8e2d067c04ce735ef2b14344ea",
  "_items": [
    {
      "item": {
        "id": "rune_neutral_offensive_1",
        "displayOrder": 60101,
        "category": "Special",
        "rarity": "Common",
        "description": "Non Multihit Attack cards deal 10 bonus DMG.",
        "inventoryDisplay": true,

GET

Get Rune By ID

https://game-api-origin.skymavis.com/v2/community/runes/rune_aquatic_2001_s0
HEADERS
X-API-Key
1f598d83-f554-4856-b7f3-cfa8b67f4be1

We will add a custom rate-limit by API Key.

PARAMS
limit
1
offset
0


Example Request
List All Rune

curl --location --request GET 'https://game-api-origin.skymavis.com/v2/community/runes' \
--header 'X-API-Key: 1f598d83-f554-4856-b7f3-cfa8b67f4be1'

Example Response
200 OK
Body
Header(6)
View More

{
  "_etag": "e10c6b8e2d067c04ce735ef2b14344ea",
  "_items": [
    {
      "item": {
        "id": "rune_neutral_offensive_1",
        "displayOrder": 60101,
        "category": "Special",
        "rarity": "Common",
        "description": "Non Multihit Attack cards deal 10 bonus DMG.",
        "inventoryDisplay": true,

GET

List All Charms

https://game-api-origin.skymavis.com/v2/community/charms
HEADERS
X-API-Key
1f598d83-f554-4856-b7f3-cfa8b67f4be1

We will add a custom rate-limit by API Key.

PARAMS



Example Request
List All Charm Success

curl --location --request GET 'https://game-api-origin.skymavis.com/v2/community/charms' \
--header 'X-API-Key: 1f598d83-f554-4856-b7f3-cfa8b67f4be1'

Example Response
200 OK
Body
Header(13)
View More

{
  "_etag": "775e98357c632dc68accb82457d8021d",
  "_items": [
    {
      "item": {
        "id": "ecard_bird_5004",
        "displayOrder": 5004,
        "category": "Special",
        "rarity": "Mystic",
        "description": "(Enhance any card)\nAdd <Ethereal>.",
        "inventoryDisplay": true,

GET

Get Charm By ID

https://game-api-origin.skymavis.com/v2/community/charms/ecard_aquatic_2001_s0
HEADERS
X-API-Key
1f598d83-f554-4856-b7f3-cfa8b67f4be1

We will add a custom rate-limit by API Key.

PARAMS



Example Request
List All Charm Success

curl --location --request GET 'https://game-api-origin.skymavis.com/v2/community/charms' \
--header 'X-API-Key: 1f598d83-f554-4856-b7f3-cfa8b67f4be1'

Example Response
200 OK
Body
Header(13)
View More

{
  "_etag": "775e98357c632dc68accb82457d8021d",
  "_items": [
    {
      "item": {
        "id": "ecard_bird_5004",
        "displayOrder": 5004,
        "category": "Special",
        "rarity": "Mystic",
        "description": "(Enhance any card)\nAdd <Ethereal>.",
        "inventoryDisplay": true,

GET

List All Items

https://game-api-origin.skymavis.com/v2/community/items
HEADERS
X-API-Key
1f598d83-f554-4856-b7f3-cfa8b67f4be1

We will add a custom rate-limit by API Key.

PARAMS
X-API-Key



Example Request
List All Items Success

curl --location --request GET 'https://game-api-origin.skymavis.com/v2/community/items' \
--header 'X-API-Key: 1f598d83-f554-4856-b7f3-cfa8b67f4be1'

Example Response
200 OK
Body
Header(13)
View More

{
  "_etag": "aa75b8cf4120512e957b1ec21af85623",
  "_items": [
    {
      "id": "rune_aquatic_offensive_1",
      "displayOrder": 62101,
      "category": "Special",
      "rarity": "Rare",
      "description": "Non-Multihit attack deal bonus DMG equal to 5% of remaining HP. Multihit attack deal bonus DMG equal to 3% of remaining HP.",
      "inventoryDisplay": true,
      "name": "Hearty Warrior",

GET

Get Item By ID

https://game-api-origin.skymavis.com/v2/community/items/rune_aquatic_2001_s0
HEADERS
X-API-Key
1f598d83-f554-4856-b7f3-cfa8b67f4be1

We will add a custom rate-limit by API Key.

PARAMS
X-API-Key



Example Request
List All Items Success

curl --location --request GET 'https://game-api-origin.skymavis.com/v2/community/items' \
--header 'X-API-Key: 1f598d83-f554-4856-b7f3-cfa8b67f4be1'

Example Response
200 OK
Body
Header(13)
View More

{
  "_etag": "aa75b8cf4120512e957b1ec21af85623",
  "_items": [
    {
      "id": "rune_aquatic_offensive_1",
      "displayOrder": 62101,
      "category": "Special",
      "rarity": "Rare",
      "description": "Non-Multihit attack deal bonus DMG equal to 5% of remaining HP. Multihit attack deal bonus DMG equal to 3% of remaining HP.",
      "inventoryDisplay": true,
      "name": "Hearty Warrior",

User Item


GET

List User Items

https://game-api-origin.skymavis.com/v2/community/users/items?userID=1ec9eb6f-4d26-67e3-a60c-6773c6c577ed&itemIDs=slp&itemIDs=moonshard&limit=20&offset=0
HEADERS
X-API-Key
1f598d83-f554-4856-b7f3-cfa8b67f4be1

We will add a custom rate-limit by API Key.

PARAMS
userID
1ec9eb6f-4d26-67e3-a60c-6773c6c577ed
itemIDs
slp

itemIDs is an array of ids to filter. If you want to get all then leave it blank

itemIDs
moonshard
limit
20
offset
0


Example Request
List User Items

curl --location --request GET 'https://game-api-origin.skymavis.com/v2/community/users/items?userID=1ec9eb6f-4d26-67e3-a60c-6773c6c577ed&itemIDs=slp&itemIDs=moonshard&limit=20&offset=0' \
--header 'X-API-Key: 1f598d83-f554-4856-b7f3-cfa8b67f4be1'

Example Response
200 OK
Body
Header(11)
View More

{
  "_etag": "705373f718c743ebff6e286ec04e6dc3",
  "_items": [
    {
      "userId": "1ec9eb6f-4d26-67e3-a60c-6773c6c577ed",
      "itemId": "moonshard",
      "quantity": 2808,
      "_etag": "5160151e96bfc358f3dea3eaa17ad684"
    },
    {
      "userId": "1ec9eb6f-4d26-67e3-a60c-6773c6c577ed",

User Map


GET

List Chapter Cleared

https://game-api-origin.skymavis.com/v2/community/users/chapters?userID=1ecaa897-a54d-66e5-bbb6-5951393dde0a&limit=10&offset=0
HEADERS
X-API-Key
1f598d83-f554-4856-b7f3-cfa8b67f4be1

We will add a custom rate-limit by API Key.

PARAMS
userID
1ecaa897-a54d-66e5-bbb6-5951393dde0a
limit
10
offset
0


Example Request
List Chapter Cleared

curl --location --request GET 'https://game-api-origin.skymavis.com/v2/community/users/chapters?userID=1ecaa897-a54d-66e5-bbb6-5951393dde0a&limit=10&offset=0' \
--header 'X-API-Key: 1f598d83-f554-4856-b7f3-cfa8b67f4be1'

Example Response
200 OK
Body
Header(13)
View More

{
  "_etag": "5f9c4fb7614bd59a4217ff14ccd9237b",
  "_items": [
    {
      "userID": "1ecaa897-a54d-66e5-bbb6-5951393dde0a",
      "chapterID": 1,
      "milestone": [
        1
      ],
      "_links": {},
      "_etag": "2bb78febf8ee76fb3ab2186ce3369e1b",

GET

List Node Cleared

https://game-api-origin.skymavis.com/v2/community/users/nodes?userID=1ecaa897-a54d-66e5-bbb6-5951393dde0a&limit=10&offset=0
HEADERS
X-API-Key
1f598d83-f554-4856-b7f3-cfa8b67f4be1

We will add a custom rate-limit by API Key.

PARAMS
userID
1ecaa897-a54d-66e5-bbb6-5951393dde0a
limit
10
offset
0


Example Request
List Node Cleared

curl --location --request GET 'https://game-api-origin.skymavis.com/v2/community/users/nodes?userID=1ecaa897-a54d-66e5-bbb6-5951393dde0a&limit=10&offset=0' \
--header 'X-API-Key: 1f598d83-f554-4856-b7f3-cfa8b67f4be1'

Example Response
200 OK
Body
Header(13)
View More

{
  "_etag": "0f06ae2897588a7613a3307d2528166b",
  "_items": [
    {
      "userID": "1ecaa897-a54d-66e5-bbb6-5951393dde0a",
      "nodeID": 1,
      "stars": 3,
      "createdAt": 1656559152,
      "_links": {},
      "_etag": "e5e0f8aec2e7d204fecc23563133cf35",
      "_isNew": false

User Fighter


GET

List User's Fighters

https://game-api-origin.skymavis.com/v2/community/users/fighters?userID=1ecaa897-a54d-66e5-bbb6-5951393dde0a&axieType=0&limit=5&offset=0
HEADERS
X-API-Key
1f598d83-f554-4856-b7f3-cfa8b67f4be1

We will add a custom rate-limit by API Key.

PARAMS
userID
1ecaa897-a54d-66e5-bbb6-5951393dde0a
axieType
0
limit
5
offset
0


Example Request
List User Axies

curl --location --request GET 'https://game-api-origin.skymavis.com/v2/community/users/fighters?userID=1ecaa897-a54d-66e5-bbb6-5951393dde0a&axieType=0&limit=5&offset=0' \
--header 'X-API-Key: 1f598d83-f554-4856-b7f3-cfa8b67f4be1'

Example Response
200 OK
Body
Header(13)
View More

{
  "_etag": "9a611cb2e75c83fc353e0cdf5119e51d",
  "_items": [
    {
      "id": 1,
      "axieType": 0,
      "userID": "1ecaa897-a54d-66e5-bbb6-5951393dde0a",
      "class": "Beast",
      "name": "Buba",
      "genes": "2713877200193586881670760504490954204872508201267083872911558106774743754828",
      "stats": {

GET

List FIghter Config of User

https://game-api-origin.skymavis.com/v2/community/users/fighters/configs?userID=1ecaa897-a54d-66e5-bbb6-5951393dde0a&limit=20&offset=0
HEADERS
X-API-Key
1f598d83-f554-4856-b7f3-cfa8b67f4be1

We will add a custom rate-limit by API Key.

PARAMS
userID
1ecaa897-a54d-66e5-bbb6-5951393dde0a
limit
20
offset
0


Example Request
List FIghter Config of User

curl --location --request GET 'https://game-api-origin.skymavis.com/v2/community/users/fighters/configs?userID=1ecaa897-a54d-66e5-bbb6-5951393dde0a&limit=20&offset=0' \
--header 'X-API-Key: 1f598d83-f554-4856-b7f3-cfa8b67f4be1'

Example Response
200 OK
Body
Header(13)
View More

{
  "_etag": "63845f92db9f47d2b75c1e71edc550c5",
  "_items": [
    {
      "id": 274,
      "name": "Default",
      "charms": {
        "eyes": "ecard_neutral_1002",
        "ears": "ecard_neutral_1001"
      },
      "runes": [

Leaderboard


GET

List Leaderboard

https://game-api-origin.skymavis.com/v2/leaderboards?limit=100&offset=0
HEADERS
X-API-Key
1f598d83-f554-4856-b7f3-cfa8b67f4be1

We will add a custom rate-limit by API Key.

PARAMS
limit
100
offset
0


Example Request
List Leaderboard

curl --location --request GET 'https://game-api-origin.skymavis.com/v2/leaderboards?userID=1ecaa897-a54d-66e5-bbb6-5951393dde0a&limit=100&offset=0' \
--header 'X-API-Key: 1f598d83-f554-4856-b7f3-cfa8b67f4be1'

Example Response
200 OK
Body
Header(6)
View More

{
  "_etag": "ff5691349184631315f14510fdb6e1b4",
  "_items": [
    {
      "userID": "1ec9eb6f-4949-6994-a60c-4eb291ec72cc",
      "name": "akaringo",
      "rank": "Challenger",
      "tier": 0,
      "topRank": 1,
      "vstar": 697,
      "avatar": null,

Battle Log

This group API only return the top 1000 battle log for each user.


GET

Get PvE Log By UserID

https://x.skymavis.com/origin/battle-history?type=pve&client_id=1ec9eb7e-579e-6a97-a60c-dd46969f474e&limit=5&page=1
HEADERS
X-API-Key
1f598d83-f554-4856-b7f3-cfa8b67f4be1

We will add a custom rate-limit by API Key.

PARAMS
type
pve
client_id
1ec9eb7e-579e-6a97-a60c-dd46969f474e
limit
5

Minimum: 5 Maximum: 100

page
1

The number of page you want to get Maximum page: 20



Example Request
Get PvE Log By UserID

curl --location --request GET 'https://x.skymavis.com/origin/battle-history?type=pve&client_id=1ec9eb7e-579e-6a97-a60c-dd46969f474e&limit=5&page=1'

Example Response
200 OK
Body
Header(12)
View More

{
  "battles": [
    {
      "battle_uuid": "bf25146d-1685-4a01-9c45-eeaa740654f9",
      "client_ids": [
        "1ec9eb7e-579e-6a97-a60c-dd46969f474e"
      ],
      "team_ids": [
        1878939
      ],
      "chimera_party_id": "party_10",

GET

Get Ranked Log By UserID

https://x.skymavis.com/origin/battle-history?type=pvp&client_id=1ec9eb7e-579e-6a97-a60c-dd46969f474e&limit=5&page=1

The battle result will base on the enum of the winner field with a sequence from
the client_ids field.

0: 1st player win

1: 2nd player win

2: draw

HEADERS
X-API-Key
1f598d83-f554-4856-b7f3-cfa8b67f4be1

We will add a custom rate-limit by API Key.

PARAMS
type
pvp
client_id
1ec9eb7e-579e-6a97-a60c-dd46969f474e
limit
5

Minimum: 5 Maximum: 100

page
1

The number of page you want to get Maximum page: 20



Example Request
Get Ranked Log By UserID

curl --location --request GET 'https://x.skymavis.com/origin/battle-history?type=pvp&client_id=1ec9eb7e-579e-6a97-a60c-dd46969f474e&limit=5&page=1'

Example Response
200 OK
Body
Header(12)
View More

{
  "battles": [
    {
      "battle_uuid": "38e98def-69aa-44d3-89a0-716f8c4ab3ee",
      "client_ids": [
        "1ecefeae-42e3-6725-b44c-335304aaefae",
        "1ec9eb7e-579e-6a97-a60c-dd46969f474e"
      ],
      "team_ids": [
        1698944,
        2304584

GET

Esport Battle Log

https://x.skymavis.com/origin-esport/battle-history?type=pvp&client_id=1ec9eb7e-579e-6a97-a60c-dd46969f474e&limit=5&page=1

This API doc is for Esport only.

HEADERS
X-API-Key
1f598d83-f554-4856-b7f3-cfa8b67f4be1

We will add a custom rate-limit by API Key.

PARAMS
type
pvp
client_id
1ec9eb7e-579e-6a97-a60c-dd46969f474e
limit
5

Minimum: 5 Maximum: 100

page
1

The number of page you want to get Maximum page: 20



Example Request
Get Ranked Log By UserID

curl --location --request GET 'https://x.skymavis.com/origin/battle-history?type=pvp&client_id=1ec9eb7e-579e-6a97-a60c-dd46969f474e&limit=5&page=1'

Example Response
200 OK
Body
Header(12)
View More

{
  "battles": [
    {
      "battle_uuid": "38e98def-69aa-44d3-89a0-716f8c4ab3ee",
      "client_ids": [
        "1ecefeae-42e3-6725-b44c-335304aaefae",
        "1ec9eb7e-579e-6a97-a60c-dd46969f474e"
      ],
      "team_ids": [
        1698944,
        2304584

GET

Battle Replay

https://storage.googleapis.com/origin-production/origin.html?f=rpl&q=5bb93bdd-0b23-4f3b-9550-38f9725b4d5b&userId=1ec9eb6f-4d26-67e3-a60c-6773c6c577ed
PARAMS
f
rpl
q
5bb93bdd-0b23-4f3b-9550-38f9725b4d5b

Battle ID

userId
1ec9eb6f-4d26-67e3-a60c-6773c6c577ed

User ID



Example Request
Battle Replay

curl --location --request GET 'https://storage.googleapis.com/origin-production/origin.html?f=rpl&q=5bb93bdd-0b23-4f3b-9550-38f9725b4d5b&userId=1ec9eb6f-4d26-67e3-a60c-6773c6c577ed'

Burned Items

Tokens consumed specifically in Origin.


GET

Get Burned Item

https://game-api-origin.skymavis.com/v2/community/users/1ec9eb6f-4d26-67e3-a60c-6773c6c577ed/items/burned?startAt=1663128000&endAt=1668484800&itemID=slp
PARAMS
startAt
1663128000

Start time to query

endAt
1668484800

End time to query

itemID
slp

The item id you want to filter: [slp, axs]



Example Request
Get Burned Item

curl --location --request GET 'https://game-api-origin.skymavis.com/v2/community/users/1ec9eb6f-4d26-67e3-a60c-6773c6c577ed/items/burned?startAt=1663128000&endAt=1668484800&itemID=slp'

Example Response
200 OK
Body
Header(10)

{
  "name": "slp",
  "total": 2950
}