Xiaohongshu image search API

Try it

Sign in and run one real call. The result and charge appear right here.

Request JSON body

Email

Security check

Loading the security check…

6-digit code

Checking live execution status…

Execution result

// Result

Request parameters

querystringrequired

minLength: 1 · maxLength: 100

Example: "壁纸"

cursorstringoptional

minLength: 1

Request JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "query": {
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "cursor": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

Code samples

Install the SDK with npm i @dataxapi/sdk or pip install dataxapi, and put your API key in the DATAXAPI_API_KEY environment variable.

curl -X POST https://api.dataxapi.com/v1/xiaohongshu/images/search \
  -H "Authorization: Bearer $DATAXAPI_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"query":"壁纸"}'

import { ExactApiClient } from "@dataxapi/sdk";

const client = new ExactApiClient({
  baseUrl: "https://api.dataxapi.com",
  apiKey: process.env.DATAXAPI_API_KEY,
});

const result = await client.call("xiaohongshu_images_search_v1", {
  "query": "壁纸"
});
console.log(result.data);

import os
from dataxapi import ExactApiClient

client = ExactApiClient("https://api.dataxapi.com", os.environ["DATAXAPI_API_KEY"])

result = client.call("xiaohongshu_images_search_v1", {
    "query": "壁纸",
})
print(result["data"])

[mcp_servers.dataxapi]
url = "https://api.dataxapi.com/mcp"
bearer_token_env_var = "DATAXAPI_API_KEY"

Response example

200 · application/json

{
  "code": 200,
  "request_id": "req_example_batch_5_xiaohongshu",
  "message": "success",
  "data": {
    "items": [
      {
        "note_id": "68da7e46000000001201cb8a",
        "title": "Public image result",
        "description": "Public image description",
        "published_at": "2025-10-21T00:00:00.000Z",
        "image_url": "https://ci.xiaohongshu.com/search-image?sign=public",
        "width": 1080,
        "height": 1928,
        "author": {
          "id": "60a6132e000000000100985e",
          "name": "Public creator",
          "avatar_url": "https://ci.xiaohongshu.com/avatar?sign=public"
        },
        "metrics": {
          "likes": 572,
          "collects": 217,
          "comments": 12,
          "shares": 0
        }
      }
    ]
  },
  "page": {
    "next_cursor": "cursor_example"
  },
  "warnings": [],
  "meta": {
    "listing_id": "xiaohongshu.images.search",
    "version": "v1",
    "catalog_release_id": "catalog-production-2026-09-19.b069be57",
    "price_book_version": "pricebook-production-2026-09-19.4487e352",
    "result_status": "complete",
    "charged_amount": "0.19",
    "balance_after": "49.81",
    "currency": "CNY"
  }
}

Response fields

codenumber: const: 200
request_idstring
messagestring: const: "success"
dataobject
pageobject
warningsarray
metaobject

Response JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "code": {
      "type": "number",
      "const": 200
    },
    "request_id": {
      "type": "string"
    },
    "message": {
      "type": "string",
      "const": "success"
    },
    "data": {
      "type": "object",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "note_id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 128,
                "pattern": "^[A-Za-z0-9_-]+$"
              },
              "title": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "published_at": {
                "anyOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "image_url": {
                "type": "string"
              },
              "width": {
                "anyOf": [
                  {
                    "type": "integer",
                    "exclusiveMinimum": 0,
                    "maximum": 9007199254740991
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "height": {
                "anyOf": [
                  {
                    "type": "integer",
                    "exclusiveMinimum": 0,
                    "maximum": 9007199254740991
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "author": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "minLength": 1,
                    "maxLength": 128,
                    "pattern": "^[A-Za-z0-9_-]+$"
                  },
                  "name": {
                    "type": "string"
                  },
                  "avatar_url": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                "required": [
                  "id",
                  "name",
                  "avatar_url"
                ],
                "additionalProperties": false
              },
              "metrics": {
                "type": "object",
                "properties": {
                  "likes": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "collects": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "comments": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "shares": {
                    "anyOf": [
                      {
                        "type": "integer",
                        "minimum": 0,
                        "maximum": 9007199254740991
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                "required": [
                  "likes",
                  "collects",
                  "comments",
                  "shares"
                ],
                "additionalProperties": false
              }
            },
            "required": [
              "note_id",
              "title",
              "description",
              "published_at",
              "image_url",
              "width",
              "height",
              "author",
              "metrics"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "items"
      ],
      "additionalProperties": false
    },
    "page": {
      "type": "object",
      "properties": {
        "next_cursor": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "next_cursor"
      ],
      "additionalProperties": false
    },
    "warnings": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "meta": {
      "type": "object",
      "properties": {
        "listing_id": {
          "type": "string",
          "const": "xiaohongshu.images.search"
        },
        "version": {
          "type": "string",
          "const": "v1"
        },
        "catalog_release_id": {
          "type": "string",
          "minLength": 1
        },
        "price_book_version": {
          "type": "string",
          "minLength": 1
        },
        "result_status": {
          "type": "string",
          "enum": [
            "complete",
            "empty",
            "partial"
          ]
        },
        "charged_amount": {
          "type": "string"
        },
        "balance_after": {
          "type": "string"
        },
        "currency": {
          "type": "string",
          "const": "CNY"
        }
      },
      "required": [
        "listing_id",
        "version",
        "catalog_release_id",
        "price_book_version",
        "result_status",
        "charged_amount",
        "balance_after",
        "currency"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "code",
    "request_id",
    "message",
    "data",
    "page",
    "warnings",
    "meta"
  ],
  "additionalProperties": false
}

Usage notes

Good for

Use it to discover keyword-matched image examples traceable to public notes.

Not for

Do not use it for reverse-image search, copyright clearance, or exhaustive recall.

Known limitations

The live first page returned 20 items.
Ranking and recall follow the current search surface.
V1 returns one preview URL and does not proxy original downloads.

Billing

¥0.19 per call. Complete and confirmed empty results are charged; partial results and failures are not.

See all pricing →