Aidir DocsUser Profile
API for getting Twitter user profile information
User Profile
Get a Twitter user's profile information.
Request
URL: /api/twitter/user-profile
Method: GET or POST
Request Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| screenName | string | Yes | User's screen name/username |
Response
A successful response will return detailed profile information, including username, bio, follower count, profile picture URL, etc.
Examples
Request Example
# GET request
curl --request GET \
--url 'https://www.aidir.fun/api/twitter/user-profile?screenName=elonmusk' \
--header 'X-API-Key: <api-key>'
# POST request
curl --request POST \
--url 'https://www.aidir.fun/api/twitter/user-profile' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"screenName": "elonmusk"
}'Response Example
{
"data": {
"type": "user",
"userName": "Elon Musk",
"url": "https://twitter.com/elonmusk",
"id": "44196397",
"name": "Elon Musk",
"isBlueVerified": true,
"profilePicture": "https://pbs.twimg.com/profile_images/1234567890/avatar.jpg",
"coverPicture": "https://pbs.twimg.com/profile_banners/44196397/1234567890/1500x500",
"description": "CEO of companies",
"location": "A Shortcut to the Stars",
"followers": 123456789,
"following": 123,
"canDm": true,
"createdAt": "2009-06-02T20:12:29.000Z",
"favouritesCount": 12345,
"hasCustomTimelines": true,
"isTranslator": false,
"mediaCount": 1234,
"statusesCount": 12345
}
}Error Responses
| Status Code | Description |
|---|---|
| 400 | Request parameter error, e.g., missing required screenName parameter |
| 401 | Authentication failed, API key invalid or missing |
| 404 | User does not exist |
| 500 | Internal server error |