{
  "openapi": "3.0.1",
  "info": {
    "title": "iQIYI Album Profile & Channel Ranking Scraper",
    "description": "Get iQIYI drama, movie, anime and variety-show details by album ID, pull the top-ranked titles for any channel, or fetch search-box suggestions for a query. Returns genres, cast, episode counts, ratings and licensed regions.",
    "version": "1.0",
    "x-build-id": "8qFI5HOJyCNleBrtc"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/dataspryva~iqiyi-album-profile-and-channel-ranking-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-dataspryva-iqiyi-album-profile-and-channel-ranking-scraper",
        "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~iqiyi-album-profile-and-channel-ranking-scraper/runs": {
      "post": {
        "operationId": "runs-sync-dataspryva-iqiyi-album-profile-and-channel-ranking-scraper",
        "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~iqiyi-album-profile-and-channel-ranking-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-dataspryva-iqiyi-album-profile-and-channel-ranking-scraper",
        "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": [
              "byId",
              "searchTitles",
              "rankings",
              "search",
              "trending"
            ],
            "type": "string",
            "description": "What to fetch.",
            "default": "byId"
          },
          "albumIds": {
            "title": "Album IDs or URLs (mode=byId)",
            "type": "array",
            "description": "iQIYI album slugs, album URLs, play URLs or numeric album IDs. Examples: `genius-girlfriend-2026-28fzrln6il1`, `https://www.iq.com/album/fated-hearts-2025-d6iyehcx4p`, `https://www.iq.com/play/fated-hearts-episode-1-1ggw7a63yug`, `1324877168319701`.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "searchQueries": {
            "title": "Search queries (mode=searchTitles)",
            "type": "array",
            "description": "Title keywords or iq.com search URLs. Each query is searched in the selected region and language.",
            "default": [
              "love"
            ],
            "items": {
              "type": "string"
            }
          },
          "searchQuery": {
            "title": "Suggestion query (mode=search)",
            "type": "string",
            "description": "Text used by the legacy search-box suggestion mode, e.g. `love`.",
            "default": "love"
          },
          "region": {
            "title": "Catalogue region (mode=searchTitles)",
            "enum": [
              "intl",
              "vn",
              "th",
              "id",
              "my",
              "ph",
              "sg",
              "kr",
              "jp"
            ],
            "type": "string",
            "description": "iQIYI serves a different catalogue per region. `intl` is the global catalogue; the others are regional catalogues.",
            "default": "intl"
          },
          "language": {
            "title": "Metadata language (mode=searchTitles)",
            "enum": [
              "en_us",
              "zh_cn",
              "zh_tw",
              "th_th",
              "vi_vn",
              "id_id",
              "ms_my"
            ],
            "type": "string",
            "description": "Language for titles and metadata. These are the languages iQIYI currently returns for search results.",
            "default": "en_us"
          },
          "includeDetails": {
            "title": "Include album details in search (mode=searchTitles)",
            "type": "boolean",
            "description": "Add score, exact release year, description, genres, age rating and cast roles to search results by reading each matching album profile.",
            "default": true
          },
          "includeEpisodes": {
            "title": "Include episode lists",
            "type": "boolean",
            "description": "Include every currently released episode for album profiles and search results. Planned episode counts are always returned.",
            "default": true
          },
          "rankingType": {
            "title": "Ranking (mode=rankings)",
            "enum": [
              "top10",
              "hot",
              "anticipated",
              "rising",
              "mustWatch",
              "dramaPicks",
              "moviePicks",
              "animePicks",
              "varietyPicks",
              "channelDrama",
              "channelMovie",
              "channelAnime",
              "channelVariety"
            ],
            "type": "string",
            "description": "Which ranking list to fetch.",
            "default": "top10"
          },
          "channelId": {
            "title": "Channel (mode=trending, legacy)",
            "enum": [
              "0",
              "1",
              "2",
              "4",
              "6"
            ],
            "type": "string",
            "description": "Legacy channel ranking selector. 0 = Top, 1 = Movie, 2 = Series, 4 = Anime, 6 = Variety.",
            "default": "2"
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Hard cap on emitted records.",
            "default": 25
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}