Skip to main content
POST
Reference example
PGY content square leaderboards Pricing — billed per successful call; the final charge scales by your plan multiplier. Charged only when the upstream response body code is 200.
Response structure is not yet fully documented — refer to the actual API response.

Example

Request contract

  • Method and path: POST /apis/v1/tikhub/xiaohongshu/pgy/get_content_square
  • Availability: enabled
  • Request URL template: https://api.aisa.one/apis/v1/tikhub/xiaohongshu/pgy/get_content_square
  • Runtime facts: 85ae03121f63417c9ff9d57a0fd59fdc6386fd71e2dc732a002843e6d8979d87
Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

Cost and request rules

Published reference price: $0.02 USD per successful request. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.
  • Default request reference estimate (USD): 0.02
  • Cost contract: fixed_success
  • Published reference multiplier: 1.0
  • Settlement evidence source: request_snapshot

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
biz_type
enum<integer>
required

Leaderboard: 1=Xiaohongshu Popular, 2=Product Seeding, 3=E-commerce Promotion, 4=Dandelion Collaboration, 5=Lead Collection, 6=E-commerce Hot, 7=Direct Seeding, 8=App Promotion

Available options:
1,
2,
3,
4,
5,
6,
7,
8
Example:

1

author_type
enum<integer> | null

Board 4 only: 1=Dandelion creator, 2=celebrity

Available options:
1,
2,
null
Example:

1

category
string | null

Board 1 only. Category uses the literal prefixes "内容类目#" or "所属行业#" followed by an original Chinese label, for example "内容类目#美妆". Copy labels verbatim; do not translate them.

Maximum string length: 64
Example:

"内容类目#美妆"

content_type
enum<integer> | null

Content source: 1=Blogger partnership, 2=Celebrity partnership, 3=Employee, 5=Buyer, 6=Professional account, 11=Director, -1=User

Available options:
1,
2,
3,
5,
6,
11,
-1,
null
Example:

1

date_range
enum<integer>
default:7

Date window in days: 3, 7 (default), 14, or 30.

Available options:
3,
7,
14,
30
Example:

7

fans

Creator follower count range (board 4 only)

industry
string | null

Industry name, used by boards 2/3/4/5/6/7/8. Copy the original Chinese label verbatim. Boards 3 and 6 use e-commerce product categories; the other boards use industry names.

Maximum string length: 64
Example:

"母婴"

marketing_target
enum<integer> | null

Board 3 only: 3=product promotion, 8=live stream promotion

Available options:
3,
8,
null
Example:

3

note_type
enum<integer> | null

Content type: 1=Image+text, 2=Video

Available options:
1,
2,
null
Example:

2

order_by
string
default:""

Sort field. Leave empty to use the default for the selected board; see the endpoint sort-key table.

Maximum string length: 64
Example:

"premium_imp_num"

page_num
integer
default:1

Page number, 1-100. Each board exposes only 100 items; keep all other parameters unchanged between pages.

Required range: 1 <= x <= 100
Example:

1

page_size
integer
default:34

Items per page, 1-34; defaults to 34 as on the web page.

Required range: 1 <= x <= 34
Example:

34

placement
enum<integer> | null

Traffic placement (boards 2/3/5/7/8): 1=Discover feed, 2=Search, 3=In-video traffic

Available options:
1,
2,
3,
null
Example:

1

price

Creator price (board 4 only)

search_word
string
default:""

Search keyword; leave empty to view the full board. Supports comma-separated batch search.

Maximum string length: 100
Example:

"Face Mask"

sub_biz_type
enum<integer> | null

Board 8 only: 1=app download, 2=mini-program promotion, 3=app re-engagement (default).

Available options:
1,
2,
3,
null
Example:

3

theme
string | null

Theme name, used by boards 2/4/5/7/8. Copy the original Chinese theme label verbatim.

Maximum string length: 64
Example:

"开箱"

Response

Successful response. The outer object follows ResponseModel; the endpoint-specific payload is in data.

7. Return

  • noteList[]: matched notes; each has noteInfo (title, noteType, noteLink, noteImages, readNum, likeNum, favNum, cmtNum, videoDuration, notePublishTime) plus blogger info
  • total: always 100 (board capacity)
  • pageInfoDto: upstream paging echo; its totalPage is always 0 and unusable

Response shape (two layers)

  • resp["data"] is PGY's raw envelope (with code/msg/success); the payload is one level deeper
  • Correct access: data = resp["data"]["data"] — every field listed under "Return" lives here
cache_message
string | null
default:This response is cached and accessible via the URL below for 24 hours at no extra cost. The cache is for request tracing only — it doesn't affect the API's data freshness and won't be returned through the API again.

Cache message (EN-US)

cache_message_zh
string | null
default:本次响应已缓存,可通过下方 URL 直接查看,有效期 24 小时,访问缓存链接无额外费用。缓存仅用于请求溯源,不影响接口数据的时效性,也不会再次通过接口返回。

Cache message (ZH-CN)

cache_url
string | null

The URL to access the cached result

code
integer
default:200

HTTP status code

data
any

Endpoint-specific response payload. The official shared model does not declare a fixed type or field set. Use the operation's documented return fields or response example; an operation-specific schema, when present, describes the documented fields. Undocumented fields must be read from the actual response rather than assumed.

docs
string | null

Link to the API Swagger documentation for this endpoint

message
string
default:Request successful. This request will incur a charge.

Response message (EN-US)

message_zh
string
default:请求成功,本次请求将被计费。

Response message (ZH-CN)

params
any
default:{}

The parameters used in the request

request_id
string | null

Unique request identifier

router
string
default:""

The endpoint that generated this response

support
string
default:Discord: https://discord.gg/aMEAS8Xsvz

Support message

time
string

The time the response was generated

time_stamp
integer

The timestamp the response was generated

time_zone
string
default:America/Los_Angeles

The timezone of the response time