Xiaohongshu Social Media API

OnlinePublic Project

Xiaohongshu(Little Red Book) Social Media public data API.

Contact Service Provider

Instructions for use: All merchants with online projects and users who purchase services are deemed to have agreed to the service provider agreement of this platform. If you have any questions about the service itself, please contact the supplier. If there are disputes, you can contact the platform for assistance. [Service Provider Agreement]

API Calls

Basic usage

All API need to pass apikey in the query string parameter for authentication. [apikey]
All API return json format. Regardless of whether the request is successful or not, the response status is 200.
Please judge whether it is successful based on the code field. For details, please refer to the explanation below.
It is recommended to determine whether retry is needed based on the code and credits fields. When credits>0, please do not repeat the request.
The timeout should be greater than 60 seconds to avoid deductions caused by early termination of the request.

Top-level field explanation

Name	Description
code	(Required) Return code. The return result is determined based on this field. See the table below for detailed meaning.
credits	(Required) Consumed credits in this call.
result	(Optional) The complete original return result, field structure and explanation should be provided by the supplier.
msg	(Optional) Reason for request failure.
tip	(Optional) Other prompt information.

Return code explanation (Integer)

code	Description	Remark
0	The request is correct without any errors
1000	Internal error	Normally you can just retry
1001	Parameter error	Please modify the parameters and retry
1002	The requested resource does not exist and may be deleted.	In this case, please do not retry
1003	Internal processing is busy, please retry later	Generally, the internal request resources are temporarily insufficient or the API is temporarily unavailable. Take a rest and try again.
1004	Insufficient permissions	Please contact the administrator to activate permissions
1005	Insufficient balance	Please recharge

APIsOnly display online Endpoints

用户详情 - V2 Low to $0.0025/request

GEThttps://apiok.us/api/0eab/user/info/v2

3 days ago100.00% uptime(avg 1656ms)now

Public APItimeout=10s qps/unlimit qpm/unlimit

Get user basic information.

Pricing Stage Price

rpd(request per day)	Unit Price(USD)
0 <= rpd < 1000	0.005 USD /request
1000 <= rpd < 5000	0.004 USD /request
5000 <= rpd < 20000	0.003 USD /request
20000 <= rpd	0.0025 USD /request

Query Params

Name	Type	Required	Default Value	Example	Description
apikey	string	true		idr_***	Copy apikey from Console
user_id	string	true		55497b8db203d976b714f525	user id

A list of user notes Low to $0.0025/request

GEThttps://apiok.us/api/0eab/user/notes/v1

3 days ago100.00% uptime(avg 2711ms)now

Public APItimeout=60s qps/unlimit qpm/unlimit

Get a list of notes posted by users, and support page turning.

See documentation for more details. [link]↗️

Pricing Stage Price

rpd(request per day)	Unit Price(USD)
0 <= rpd < 1000	0.005 USD /request
1000 <= rpd < 5000	0.004 USD /request
5000 <= rpd < 20000	0.003 USD /request
20000 <= rpd	0.0025 USD /request

Query Params

Name	Type	Required	Example	Description
apikey	string	true	idr_***	Copy apikey from Console
user_id	string	true	55497b8db203d976b714f525	user id
page_id	string	false		Use value of field next_page_id from response for getting next page

Note details Low to $0.0025/request

GEThttps://apiok.us/api/0eab/note/detail/v1

3 days ago99.45% uptime(avg 941ms)now

Public APItimeout=60s qps/unlimit qpm/unlimit

Get note details based on ID.

See documentation for more details. [link]↗️

Pricing Stage Price

rpd(request per day)	Unit Price(USD)
0 <= rpd < 1000	0.005 USD /request
1000 <= rpd < 5000	0.004 USD /request
5000 <= rpd < 20000	0.003 USD /request
20000 <= rpd	0.0025 USD /request

Query Params

Name	Type	Required	Default Value	Example	Description
apikey	string	true		idr_***	Copy apikey from Console
note_id	string	true		5b275e5c9374260197ec884a	note id

Search the list of notes $0.01/request

GEThttps://apiok.us/api/0eab/search/notes/v1

3 days ago94.53% uptime(avg 642ms)now

Public APItimeout=60s qps/unlimit qpm/unlimit

Search the list of notes based on keywords, and support page turning.

See documentation for more details. [link]↗️

Pricing 0.01 USD /request

Query Params

Name	Type	Required	Default Value	Example	Description
apikey	string	true		idr_***	Copy apikey from Console
query	string	true		cat	keyword for search
page_id	string	false			Use value of field next_page_id from response for getting next page
sort_type	number	false	0	0	sort type: 0(综合)\|1(最热)\|2(最新)
filter_note_type	number	false	0	0	search note type: 0(默认), 1(视频筛选), 2(图文筛选)

搜索用户 $0.01/request

GEThttps://apiok.us/api/0eab/search/users/v1

3 days ago98.86% uptime(avg 3838ms)now

Public APItimeout=60s qps/unlimit qpm/unlimit

根据关键词搜索用户列表，支持翻页。

See documentation for more details. [link]↗️

Pricing 0.01 USD /request

Query Params

Name	Type	Required	Example	Description
apikey	string	true	idr_***	Copy apikey from Console
query	string	true	cat	keyword for search
page_id	string	false		Use value of field next_page_id from response for getting next page

获取笔记评论列表 Low to $0.0025/request

GEThttps://apiok.us/api/0eab/note/comments/v1

3 days ago100.00% uptime(avg 3128ms)now

Public APItimeout=60s qps/unlimit qpm/unlimit

根据笔记id获取评论列表，支持翻页。

Pricing Stage Price

rpd(request per day)	Unit Price(USD)
0 <= rpd < 1000	0.005 USD /request
1000 <= rpd < 5000	0.004 USD /request
5000 <= rpd < 20000	0.003 USD /request
20000 <= rpd	0.0025 USD /request

Query Params

Name	Type	Required	Example	Description
apikey	string	true	idr_***	Copy apikey from Console
note_id	string	true	60437a8a000000002103ac18	note id
page_id	string	false		Use value of field next_page_id from response for getting next page

获取评论的回复列表 Low to $0.0025/request

GEThttps://apiok.us/api/0eab/note/sub_comments/v1

3 days ago98.98% uptime(avg 3944ms)now

Public APItimeout=60s qps/unlimit qpm/unlimit

获取指定评论下的回复列表，支持翻页。

Pricing Stage Price

rpd(request per day)	Unit Price(USD)
0 <= rpd < 1000	0.005 USD /request
1000 <= rpd < 5000	0.004 USD /request
5000 <= rpd < 20000	0.003 USD /request
20000 <= rpd	0.0025 USD /request

Query Params

Name	Type	Required	Example	Description
apikey	string	true	idr_***	Copy apikey from Console
note_id	string	true	60437a8a000000002103ac18	note id
comment_id	string	true	60476a06000000002100097a	comment id
page_id	string	false		Use value of field next_page_id from response for getting next page