X

A list of Twitter APIs

baseURL: wv2h4to5qa.execute-api.us-east-2.amazonaws.com/dev/twitter

To obtain x-api-key please contact the team. You can find more information at the "Connect With Us" section


Authentication

All requests require a valid API key to be included in the x-api-key header.

Fetch Twitter User by Username

GET https://<baseURL>/user

Fetches the details of a Twitter user by their username

For the client to access data, Twitter users need to authenticate through the Camp Auth hub.

Query Parameters

NameTypeDescription

twitterUserName*

string

The username of the Twitter user

{
    "isError": boolean,
    "data": {
        "id": string,
        "displayName": string,
        "userHandle": string,
        "profileBio": string,
        "profilePictureUrl": string,
        "isVerified": boolean,
        "isBlueVerified": boolean,
        "verifiedType": string,
        "location": string,
        "followerCount": number,
        "followingCount": number,
        "likeCount": number,
        "createdAt": string,
        "updatedAt": string
      },
    "message": string
}

Fetch Tweets by Twitter Username

GET https://<baseURL>/tweets

Fetches the tweets of a Twitter user by their username

For the client to access data, Twitter users need to authenticate through the Camp Auth hub.

Please note that tweet statistics aren't updated in real time on this display. For the latest stats, use the command /gettweetbyid below.

Query Parameters

NameTypeDescription

twitterUserName*

string

The username of the Twitter user

page

number

The current page number in the pagination. It represents which set of records you want to retrieve.

limit

number

The number of records to retrieve per page.

{
    "isError": boolean,
    "data": [
                {
                  "id": string,
                  "twitterUserId": string,
                  "tweetText": string,
                  "tweetTimestamp": string,
                  "likeCount": number,
                  "retweetCount": number,
                  "replyCount": number,
                  "quoteCount": number,
                  "mediaUrls": [string],
                  "userMentions": [string],
                  "hashtags": [string],
                  "createdAt": string,
                  "updatedAt": string
                }
          ],
    "message": string
}

Fetch Followers by Twitter Username

GET https://<baseURL>/followers

Fetches the followers of a Twitter user by their username

For the client to access data, Twitter users need to authenticate through the Camp Auth hub.

Query Parameters

NameTypeDescription

twitterUserName*

string

The username of the Twitter user

page

number

The current page number in the pagination. It represents which set of records you want to retrieve.

limit

number

The number of records to retrieve per page.

{
    "isError": boolean,
    "data": [
                {
                  "twitterUserId": string,
                  "userId": string,
                  "userHandle": string,
                  "displayName": string,
                  "type": follower,
                  "location": string,
                  "createdAt": string,
                  "updatedAt": string
                }
            ],
    "message": string
}

Fetch Following by Twitter Username

GET https://<baseURL>/following

Fetches the following of a Twitter user by their username

For the client to access data, Twitter users need to authenticate through the Camp Auth hub.

Query Parameters

NameTypeDescription

twitterUserName*

string

The username of the Twitter user

page

number

The current page number in the pagination. It represents which set of records you want to retrieve.

limit

number

The number of records to retrieve per page.

{
    "isError": boolean,
    "data": [
                {
                  "twitterUserId": string,
                  "userId": string,
                  "userHandle": string,
                  "displayName": string,
                  "type": follower,
                  "location": string,
                  "createdAt": string,
                  "updatedAt": string
                }
            ],
    "message": string
}

Fetch Tweet By Tweet id

GET https://<baseURL>/gettweetbyid

Fetches the tweet of a Twitter user by tweetId

For the client to access data, Twitter users need to authenticate through the Camp Auth hub.

Query Parameters

NameTypeDescription

tweetId*

string

The tweet id of tweet

{
    "isError": boolean,
    "data": [
                {
                  "id": string,
                  "twitterUserId": string,
                  "tweetText": string,
                  "tweetTimestamp": string,
                  "likeCount": number,
                  "retweetCount": number,
                  "replyCount": number,
                  "quoteCount": number,
                  "mediaUrls": [string],
                  "userMentions": [string],
                  "hashtags": [string],
                  "createdAt": string,
                  "updatedAt": string
                }
            ],
    "message": string
}

Fetch Twitter User by Wallet Address

GET https://<baseURL>/wallet-twitter-data

Fetches the details of a Twitter user by their wallet address

For the client to access data, Twitter users need to authenticate through the Camp Auth hub.

Query Parameters

NameTypeDescription

walletAddress*

string

The registered wallet address of the user

{
    "isError": boolean,
    "data": {
        "twitterUser": {
            "id": string,
            "displayName": string,
            "userHandle": string,
            "profileBio": string,
            "profilePictureUrl": string,
            "isVerified": boolean,
            "isBlueVerified": boolean,
            "verifiedType": string,
            "location": string,
            "likeCount": number,
            "followerCount": number,
            "followingCount": number,
            "dailyTweetCount": string,
            "weeklyTweetCount": string,
            "tweetFrequencyInDays": string,
            "lastSynced": string,
            "createdAt": string,
            "updatedAt": string
        },
        "tweets": [],
        "followers": [],
        "followings": []
    },
    "message": string
}

Fetch Users Reposted

GET https://<baseURL>/reposted

Fetches the reposted tweets by their username

For the client to access data, Twitter users need to authenticate through the Camp Auth hub.

Query Parameters

NameTypeDescription

twitterUserName*

string

The username of the Twitter user

page

number

The current page number in the pagination. It represents which set of records you want to retrieve.

limit

number

The number of records to retrieve per page.

{
  "data": [
    {
      "tweet_id": string,
      "tweet_text": string,
      "timestamp": string,
      "engagement_metrics": {
        "likes": number,
        "replies": number,
        "retweets": number,
        "quotes": number
      },
      "media_urls": [],
      "user_mentions": [
        {
          "id_str": string,
          "name": string,
          "screen_name": string
        }
      ],
      "hashtags": [],
      "language": string,
      "geolocation": string
    }
  ]
}

Fetch Users Replies

GET https://<baseURL>/replies

Fetches the Retweets/Quoted/Replies by their username

For the client to access data, Twitter users need to authenticate through the Camp Auth hub.

Query Parameters

NameTypeDescription

twitterUserName*

string

The username of the Twitter user

page

number

The current page number in the pagination. It represents which set of records you want to retrieve.

limit

number

The number of records to retrieve per page.

{
    "data": [
        {
            "replied": {
                "id": string,
                "twitterUserId": string,
                "tweetText": string,
                "tweetTimestamp": string,
                "likeCount": number,
                "retweetCount": number,
                "replyCount": number,
                "quoteCount": number,
                "isReTweet": boolean,
                "repliedTweetId": string
            },
            "repliedTo": {
                "id": string,
                "twitterUserId": string,
                "tweetText": string,
                "tweetTimestamp": string,
                "likeCount": number,
                "retweetCount": number,
                "replyCount": number,
                "quoteCount": number,
                "isReTweet": boolean,
                "repliedTweetId": string
            }
        }
    ]
}

Last updated