{
  "openapi": "3.0.1",
  "info": {
    "title": "NetEase Cloud Music Song, Chart & Playlist Scraper",
    "description": "Search NetEase Cloud Music songs, fetch song details by URL, pull an artist's top songs or album list, browse playlists by genre, or get any top-100 chart. Returns artist, album, duration, cover art, and popularity for each track.",
    "version": "1.0",
    "x-build-id": "OBp2YCjuqgFzas3t0"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dataspryva~netease-cloud-music-song-chart-and-playlist/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dataspryva-netease-cloud-music-song-chart-and-playlist",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/dataspryva~netease-cloud-music-song-chart-and-playlist/runs": {
      "post": {
        "operationId": "runs-sync-dataspryva-netease-cloud-music-song-chart-and-playlist",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/dataspryva~netease-cloud-music-song-chart-and-playlist/run-sync": {
      "post": {
        "operationId": "run-sync-dataspryva-netease-cloud-music-song-chart-and-playlist",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "required": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "bySongUrl",
              "byArtist",
              "byArtistAlbums",
              "byAlbum",
              "byPlaylist",
              "byPlaylistUrl",
              "byToplist",
              "toplists",
              "comments"
            ],
            "type": "string",
            "description": "What to fetch. Each mode reads its own list field.",
            "default": "search"
          },
          "searchQueries": {
            "title": "Search queries",
            "type": "array",
            "description": "Free-text queries (mode=search). One or more artist, song, album or playlist names.",
            "default": [
              "周杰伦"
            ],
            "items": {
              "type": "string"
            }
          },
          "searchType": {
            "title": "Search result type",
            "enum": [
              "song",
              "album",
              "artist",
              "playlist"
            ],
            "type": "string",
            "description": "Which catalog entity to search for (mode=search).",
            "default": "song"
          },
          "songUrls": {
            "title": "Song URLs or IDs (mode=bySongUrl)",
            "type": "array",
            "description": "music.163.com song URLs or bare song IDs, e.g. 186016.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "artistIds": {
            "title": "Artist IDs, URLs or names (mode=byArtist / byArtistAlbums)",
            "type": "array",
            "description": "Artist IDs, music.163.com artist URLs, or exact artist names.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "artistOrder": {
            "title": "Artist song order",
            "enum": [
              "hot",
              "time"
            ],
            "type": "string",
            "description": "Order the artist's song catalogue by popularity or release time (mode=byArtist).",
            "default": "hot"
          },
          "albumUrls": {
            "title": "Album URLs or IDs (mode=byAlbum)",
            "type": "array",
            "description": "music.163.com album URLs or bare album IDs.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "playlistUrls": {
            "title": "Playlist URLs or IDs (mode=byPlaylistUrl)",
            "type": "array",
            "description": "music.163.com playlist URLs or bare playlist IDs. Full tracklists are read.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "playlistCat": {
            "title": "Playlist category",
            "enum": [
              "全部",
              "综艺",
              "流行",
              "怀旧",
              "清晨",
              "华语",
              "影视原声",
              "摇滚",
              "夜晚",
              "清新",
              "欧美",
              "ACG",
              "民谣",
              "学习",
              "浪漫",
              "儿童",
              "日语",
              "工作",
              "校园",
              "电子",
              "韩语",
              "游戏",
              "午休",
              "粤语",
              "伤感",
              "舞曲",
              "治愈",
              "下午茶",
              "说唱",
              "70后",
              "地铁",
              "轻音乐",
              "放松",
              "80后",
              "驾车",
              "爵士",
              "孤独",
              "90后",
              "乡村",
              "感动",
              "运动",
              "网络歌曲",
              "旅行",
              "兴奋",
              "R&B/Soul",
              "KTV",
              "古典",
              "快乐",
              "经典",
              "散步",
              "翻唱",
              "民族",
              "酒吧",
              "安静",
              "英伦",
              "思念",
              "吉他",
              "金属",
              "钢琴",
              "朋克",
              "器乐",
              "蓝调",
              "榜单",
              "雷鬼",
              "00后",
              "世界音乐",
              "拉丁",
              "New Age",
              "古风",
              "后摇",
              "Bossa Nova"
            ],
            "type": "string",
            "description": "NetEase playlist genre, scene or mood to browse (mode=byPlaylist).",
            "default": "华语"
          },
          "toplistIds": {
            "title": "Chart IDs, names or URLs (mode=byToplist)",
            "type": "array",
            "description": "Chart IDs, music.163.com toplist URLs, or Chinese/English chart names. Use `all` or leave empty for every current chart.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "maxTracksPerChart": {
            "title": "Max tracks per chart",
            "minimum": 0,
            "maximum": 1000,
            "type": "integer",
            "description": "Limit tracks read from each chart before the global max items cap (mode=byToplist). 0 reads every track.",
            "default": 0
          },
          "commentUrls": {
            "title": "Comment targets (mode=comments)",
            "type": "array",
            "description": "Song, album, playlist or chart URLs/IDs. A bare ID is treated as a song; use `album:123`, `playlist:123` or `chart:123` to be explicit.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "commentOrder": {
            "title": "Comment order",
            "enum": [
              "recommended",
              "hot"
            ],
            "type": "string",
            "description": "Recommended comments or NetEase's hot-comment selection (mode=comments).",
            "default": "recommended"
          },
          "maxCommentsPerItem": {
            "title": "Max comments per resource",
            "minimum": 1,
            "maximum": 1100,
            "type": "integer",
            "description": "Maximum top-level comments read per song, album, playlist or chart (mode=comments). NetEase stops anonymous pagination around 1,100.",
            "default": 100
          },
          "includeReplies": {
            "title": "Include comment replies",
            "type": "boolean",
            "description": "Fetch the reply floor for comments that have replies (mode=comments).",
            "default": false
          },
          "maxRepliesPerComment": {
            "title": "Max replies per comment",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "How many replies to read for each comment when replies are enabled (mode=comments).",
            "default": 20
          },
          "includeArtistProfile": {
            "title": "Include artist profile",
            "type": "boolean",
            "description": "Emit one artist profile record with bio, images, sizes, rank, identities and fan count (mode=byArtist / byArtistAlbums).",
            "default": false
          },
          "includeLyrics": {
            "title": "Include lyrics",
            "type": "boolean",
            "description": "Attach full LRC lyrics plus translation, romanization and word-by-word lyrics when NetEase has them (every song mode).",
            "default": false
          },
          "includeAlbumTracks": {
            "title": "Include album tracks",
            "type": "boolean",
            "description": "Emit each album's tracks as song records (mode=byAlbum).",
            "default": true
          },
          "includePlaylistTracks": {
            "title": "Include playlist tracks",
            "type": "boolean",
            "description": "Emit the playlist's full tracklist as song records (mode=byPlaylistUrl).",
            "default": true
          },
          "includeToplistInfo": {
            "title": "Include chart summary",
            "type": "boolean",
            "description": "Emit a chart summary record before each chart's tracks (mode=byToplist).",
            "default": true
          },
          "minDurationSec": {
            "title": "Min song duration (seconds)",
            "minimum": 0,
            "maximum": 86400,
            "type": "integer",
            "description": "Skip song records shorter than this. Album, artist, playlist and chart metadata are unaffected."
          },
          "maxDurationSec": {
            "title": "Max song duration (seconds)",
            "minimum": 0,
            "maximum": 86400,
            "type": "integer",
            "description": "Skip song records longer than this. Album, artist, playlist and chart metadata are unaffected."
          },
          "minPopularity": {
            "title": "Min song popularity",
            "minimum": 0,
            "maximum": 100,
            "type": "integer",
            "description": "Skip song records below this NetEase popularity score (0-100). Metadata records are unaffected."
          },
          "minPlayCount": {
            "title": "Min playlist plays",
            "minimum": 0,
            "maximum": 1000000000000,
            "type": "integer",
            "description": "Skip browsed playlists with fewer plays (mode=byPlaylist)."
          },
          "minTrackCount": {
            "title": "Min playlist tracks",
            "minimum": 0,
            "maximum": 1000000000,
            "type": "integer",
            "description": "Skip browsed playlists with fewer tracks (mode=byPlaylist)."
          },
          "containsKeyword": {
            "title": "Contains keyword",
            "type": "string",
            "description": "Keep only records whose name contains this text (case-insensitive). Applies to songs, albums, artists, playlists and charts."
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Hard cap on total dataset records for the run, including error records.",
            "default": 100
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}