X User
Details for the X_USER link type (formerly Twitter)
Type Value: X_USER
Status: PRODUCTION
An X_USER
link type represents a user profile from X (formerly known as Twitter). Beyond the basic preview attributes (title
, description
, image
), X_USER
links provide enriched metadata about the user’s profile, social graph, and other account details. This makes it easy to display more complete and informative user profiles within your application.
What It Includes
When type
is X_USER
, the response includes an xUser
object with fields like:
- username & name: The user’s handle and display name.
- avatar & cover: Responsive images for the user’s profile picture and header image.
- bio & location: Additional context about who they are and where they’re located.
- verified: Indicates if the user is verified.
- followersCount, followingCount, postsCount: Engagement metrics that give a sense of the user’s reach and activity.
- joinedAt: The date when the account was created.
- protected & sensitive: Flags indicating if the account’s tweets are protected or contain sensitive content.
- url: A personal website URL listed in the profile.
With these attributes, you can provide richer user previews, whether building a social media aggregator or displaying user summaries in a dashboard.
Example Request
Example Response
Special Notes
- Fallback Strategies: If certain metadata is missing, Peekalink attempts to infer a title or description.
- Social Graph Metrics: Followers, following, and post counts let you highlight the user’s popularity and activity level.
- Privacy & Sensitivity Flags: Use protected and sensitive to decide how to present content from these users in your app.
Schema reference
For a full technical breakdown of all fields and validation rules, including detailed JSON schemas, please refer to the API Reference.