Skip to content
Scrappa Get API key
Kwai API 1 credit/request

Kwai Album

GET https://scrappa.co/api/kwai/album

Album metadata and its photo list. Pagination ends when the upstream cursor reports no_more.

Kwai Album 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/kwai/album
Auth header
x-api-key
Cost
1 credit/request
albumId = example
Response preview
200 OK
{
    "meta": {
        "attempts": 1,
        "billable": true,
        "duration_ms": 1240
    },
    "album": {
        "id": "3xk9qz2album",
        "title": "Best of 2026"
    },
    "cursor": null,
    "photos": [
        {
            "caption": "Album cover video",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

2 optional filters available.

albumId string Required

Kwai album id.

Example value example
pcursor string Optional

Cursor from the previous response.

Example value example
count integer Optional

Requested number of photos, 1 to 50. Default: 20.

Example value 10

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

meta album cursor photos success album_id has_more photo_count

Common photos fields

caption video_id
JSON Response
200 OK
{
    "meta": {
        "attempts": 1,
        "billable": true,
        "duration_ms": 1240
    },
    "album": {
        "id": "3xk9qz2album",
        "title": "Best of 2026"
    },
    "cursor": null,
    "photos": [
        {
            "caption": "Album cover video",
            "video_id": "3xk9qz2abcde"
        }
    ],
    "success": true,
    "album_id": "3xk9qz2album",
    "has_more": false,
    "photo_count": 1
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

502

Upstream Unavailable

The upstream service is temporarily unavailable. Please retry shortly.

{
    "meta": {
        "attempts": 2,
        "billable": false,
        "retryable": true,
        "duration_ms": 2140
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The Kwai API is temporarily unavailable. Please retry.",
        "http_status": 502,
        "failure_type": "upstream_non_200"
    },
    "success": false
}
404

Not Found

Kwai has no public data for this identifier. A not-found is a completed lookup that was not billed.

{
    "meta": {
        "attempts": 2,
        "billable": false,
        "retryable": false,
        "duration_ms": 1980
    },
    "error": {
        "code": "VIDEO_NOT_FOUND",
        "message": "Kwai has no video with this id.",
        "http_status": 404,
        "failure_type": "video_id_substituted"
    },
    "success": false
}
404

Profile Not Found

Kwai has no public profile for this handle. A not-found is a completed lookup that was not billed.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": false,
        "duration_ms": 860
    },
    "error": {
        "code": "PROFILE_NOT_FOUND",
        "message": "Kwai has no public profile for this handle.",
        "http_status": 404,
        "failure_type": "profile_not_found"
    },
    "success": false
}
422

Upstream Rejected The Request

Kwai rejected the request body as malformed. Retrying will not change the outcome, so the request is sent once and is not billed.

{
    "meta": {
        "attempts": 1,
        "billable": false,
        "retryable": false,
        "duration_ms": 1120
    },
    "error": {
        "code": "INVALID_PARAMETER",
        "message": "Kwai could not process this request. Retrying will not change the outcome.",
        "http_status": 422,
        "failure_type": "invalid_parameter_format"
    },
    "success": false
}
422

Validation Error

A required parameter is missing or malformed.

{
    "errors": {
        "user": [
            "The Kwai handle is required."
        ]
    },
    "message": "The request validation failed"
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.