GET
/
videos
curl --request GET \
  --url https://www.topyappers.com/api/v1/videos \
  --header 'x-ty-api-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "userHandle": "<string>",
      "userFollowers": 123,
      "views": 123,
      "likes": 123,
      "comments": 123,
      "shares": 123,
      "hashtags": [
        "<string>"
      ],
      "description": "<string>",
      "url": "<string>",
      "thumbnailUrl": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "platform": "tiktok"
    }
  ],
  "pagination": {
    "page": 123,
    "perPage": 123,
    "total": 123,
    "totalPages": 123
  }
}

Authorizations

​
x-ty-api-key
string
header
required

API key for TopYappers API authentication

Query Parameters

​
userHandle
string

Filter videos by specific user handle

​
userFollowersMin
integer

Minimum number of followers the video creator must have

​
userFollowersMax
integer

Maximum number of followers the video creator can have

​
viewsMin
integer

Minimum number of views the video must have

​
viewsMax
integer

Maximum number of views the video can have

​
likesMin
integer

Minimum number of likes the video must have

​
likesMax
integer

Maximum number of likes the video can have

​
commentsMin
integer

Minimum number of comments the video must have

​
commentsMax
integer

Maximum number of comments the video can have

​
sharesMin
integer

Minimum number of shares the video must have

​
sharesMax
integer

Maximum number of shares the video can have

​
hashtags
string

Filter by hashtags (comma-separated for multiple)

​
textSearch
string

Search for keywords in video description or caption

​
sortOrder
enum<string>

Sort order for results

Available options:
asc,
desc
​
sortBy
enum<string>

Field to sort results by

Available options:
user_followers,
views,
shares,
likes
​
page
integer

Page number for pagination

Required range: x >= 1
​
perPage
integer

Number of results per page

Required range: 1 <= x <= 100

Response

200
application/json

Videos response

The response is of type object.