Skip to content

xhs_query_my_notes

Query cached published notes with multi-field filtering.

Parameters

ParameterTypeRequiredDescription
accountstringNoAccount name or ID
typestringNoNote type: normal/video
levelnumberNoNote level
stickybooleanNoPinned status
permissionCodenumberNoPermission: 0=public
titleContainsstringNoTitle contains text
minLikesnumberNoMinimum likes
minCollectednumberNoMinimum collects
minCommentsnumberNoMinimum comments
minViewsnumberNoMinimum views
publishTimeStartstringNoPublish time start
publishTimeEndstringNoPublish time end
orderBystringNoSort field
orderDirstringNoSort direction: asc/desc
limitnumberNoResult limit (default: 100)
offsetnumberNoPagination offset (default: 0)
includeStatsbooleanNoInclude summary statistics

orderBy options

ValueDescription
publish_timePublish time (default)
likesLikes count
collected_countCollects count
comments_countComments count
view_countViews count
updated_atUpdate time

Response

json
{
  "account": "account-name",
  "success": true,
  "count": 10,
  "total": 50,
  "lastFetchTime": "2024-01-01T00:00:00Z",
  "notes": [...],
  "stats": {
    "totalNotes": 50,
    "totalViews": 50000,
    "totalLikes": 5000
  }
}

Examples

Query top-liked notes

xhs_query_my_notes({
  minLikes: 100,
  orderBy: "likes",
  orderDir: "desc"
})

Query by date range

xhs_query_my_notes({
  publishTimeStart: "2024-01-01",
  publishTimeEnd: "2024-01-31"
})

Search by title

xhs_query_my_notes({
  titleContains: "coffee"
})

Notes

  • Requires xhs_get_my_notes to fetch and cache data first
  • Queries run on local database for fast results

Released under the MIT License.