Docs

Query User Info

Request

HTTP URL	https://open.tiktokapis.com/v2/research/user/info/
HTTP Method	POST
Scopes	research.data.basic (required)

Headers

Key	Type	Description	Example Value
Authorization	string	The client access token obtained from /v2/oauth/token/.	Bearer clt.1234asd2387jedyghgs4easd1234asdf84jenryhdlasuie4jh

Query Parameters

Key

Type

Description

Example

Required

fields

string

Field names for desired data to be returned. It is a comma separated list.

See User Info Object below for a full list of values.

Complete list:

open_id, display_name, is_private, bio_description, avatar_url, is_verified, follower_count, following_count, likes_count, video_count

Yes

Body Parameters

This is a dynamic API, so either an open_id or a username can be provided. If both are provided, a parameter error will be returned.

Key

Type

Description

Example Value

open_id

string

open_id as the unique identifier

Optional: must provide either open_id or username, but not both.

"f9dce9a7-01bf-4c1d-a853-e98d95af5e26"

username

string

username as the unique identifier

Optional: must provide either open_id or username, but not both.

"joe11235"

Example

curl -L https://open.tiktokapis.com/v2/research/user/info/?fields=open_id,display_name,bio_description,avatar_url,is_verified,follower_count,following_count,likes_count,video_count,is_private \
-H 'Authorization: Bearer clt.someToken' \
-H 'Content-Type:application/json' \
-d '{"username": "joe123456"}'

Response

Body

Key	Type	Description
data	User Info Object	The returned user info data
error	ErrorStructV2	Error object

User Info Object

Field name	Type	Description
"open_id"	string	The unique open_id of a user
"display_name"	string	The user's display name / nickname
"is_private"	bool	If the user's TikTok account is public
"bio_description"	string	The user's bio description
"avatar_url"	string	The url to a user's profile picture
"is_verified"	bool	The user's verified status. True if verified, false if not
"following_count"	int	The number of people the user is following
"follower_count"	int	The number of followers the user has
"video_count"	int	The number of videos the user has posted
"likes_count"	int	The total number of likes the user has accumulated

Example

{
    "data": {
        "bio_description": "my_bio",
        "is_verified": false,
        "is_private": true,
        "likes_count": 27155089,
        "open_id": "12345-12345-83728634asdf",
        "video_count": 44,
        "avatar_url": "https://some_cdn.com/my_avatar",
        "follower_count": 232,
        "following_count": 45,
        "display_name": "my nick name"
    },
    "error": {
        "code": "ok",
        "message": "",
        "log_id": "202207280326050102231031430C7E754E",
    }
}