Start building

Xiaohongshu PGY content square leaderboards API docs

Open Playground →

Start building

Send your first request

Platform API endpoint with unified authentication and usage tracking.

Production API
Platform API endpoint
https://api.sandbase.ai/v1/api/xiaohongshu/pgy/content-square
Authorization header
Authorization: Bearer $SANDBASE_API_KEY
# The quoted heredoc keeps Unicode and shell metacharacters unchanged.
result=$(curl --fail-with-body --silent \
  -X POST "https://api.sandbase.ai/v1/api/xiaohongshu/pgy/content-square" \
  -H "Authorization: Bearer $SANDBASE_API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'SANDBASE_JSON'
{
  "biz_type": 1,
  "page_num": 1,
  "page_size": 20,
  "date_range": 7
}
SANDBASE_JSON
)
printf '%s\n' "$result"

2. Authentication

Set your SandBase API key in your server environment. Requests use Bearer authentication.

API key environment variable
export SANDBASE_API_KEY="YOUR_API_KEY"

Keep your key on the server. Do not expose it in browser code.

3. Parameters

biz_typeintegerrequired

Leaderboard

Possible values: 1, 2, 3, 4, 5, 6, 7, 8

page_numinteger

Page; each board has only 100 items

Default: 1

page_sizeinteger

Page size, 1-34

Default: 34

search_wordstring

Keyword, comma-separated for batch

order_bystring

Sort field, empty=board default

date_rangeinteger

7/14/Date window in days

Default: 7

Possible values: 3, 7, 14, 30

sub_biz_typeinteger

Board 8 only

Possible values: 1, 2, 3

categorystring

Board 1 only

industrystring

3/4/5/6/7/Industry, values differ per board

note_typeinteger

Content type

Possible values: 1, 2

content_typeinteger

Content source

Possible values: 1, 2, 3, 5, 6, 11, -1

themestring

4/5/7/Theme

author_typeinteger

Board 4 only

Possible values: 1, 2

placementinteger

3/5/7/Traffic placement

Possible values: 1, 2, 3

marketing_targetinteger

Board 3 only

Possible values: 3, 8

priceobject

Creator price, board 4 only

fansobject

Creator fans range, board 4 only

4. Response

Saved example response for this API; no live request is made when viewing it.

No saved response has been published. Run the API in Playground to inspect its response.