Twitter

Twitter: tweets, users, handles, and search.

Search Twitter

get

Search tweets by query. Use cursor to paginate or maxItems for a one-shot bulk pull (mutually exclusive). sort is Top or Latest (default Latest).

Cost: 160 credits/request + 1 credit/item

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

querystring · min: 1 · max: 100RequiredExample: javascript

sortstring · enumOptionalDefault: LatestPossible values:

useFirststring · enumOptionalDefault: falsePossible values:

maxItemsinteger · min: 1 · max: 200Optional

cursorstringOptional

Responses

200

Successful request

application/json

requestIdstring · uuidOptionalExample: 3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24

statusintegerOptionalExample: 200

messagestringOptionalExample: OK

successbooleanOptionalExample: true

400

Bad request

application/json

402

Insufficient credits

application/json

404

Not found

application/json

get/twitter/search

GET /twitter/search?query=text HTTP/1.1
Host: api.pullbay.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "requestId": "3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24",
  "status": 200,
  "message": "OK",
  "success": true,
  "data": [
    {
      "type": "tweet",
      "id": "20",
      "url": "https://x.com/jack/status/20",
      "twitterUrl": "https://twitter.com/jack/status/20",
      "text": "just setting up my twttr",
      "fullText": "just setting up my twttr",
      "source": "Twitter Web Client",
      "lang": "en",
      "createdAt": "Tue Mar 21 20:50:14 +0000 2006",
      "conversationId": "20",
      "retweetCount": 126541,
      "replyCount": 17858,
      "likeCount": 309719,
      "quoteCount": 6384,
      "bookmarkCount": 21386,
      "viewCount": null,
      "isReply": false,
      "isPinned": false,
      "isRetweet": false,
      "isQuote": false,
      "author": {
        "type": "user",
        "id": "44196397",
        "userName": "elonmusk",
        "name": "Elon Musk",
        "url": "https://x.com/elonmusk",
        "twitterUrl": "https://twitter.com/elonmusk",
        "description": "https://t.co/dDtDyVssfm",
        "location": "",
        "profilePicture": "https://pbs.twimg.com/profile_images/2035314704307081216/71U1ftM3_normal.jpg",
        "coverPicture": "https://pbs.twimg.com/profile_banners/44196397/1774145451",
        "isVerified": true,
        "isBlueVerified": true,
        "protected": false,
        "canDm": false,
        "canMediaTag": false,
        "followers": 239698341,
        "following": 1319,
        "fastFollowersCount": 0,
        "favouritesCount": 225074,
        "listedCount": 168631,
        "mediaCount": 4467,
        "statusesCount": 101980,
        "createdAt": "Tue Jun 02 20:12:29 +0000 2009",
        "status": ""
      },
      "media": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "hasNextPage": null,
    "cursor": null,
    "offset": null
  },
  "pricing": {
    "creditsCharged": 161
  }
}

Get a tweet by ID

get

Returns a single tweet by its numeric ID.

Cost: 4 credits/request + 1 credit/item

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · min: 1 · max: 100RequiredExample: 20

Responses

200

Successful request

application/json

requestIdstring · uuidOptionalExample: 3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24

statusintegerOptionalExample: 200

messagestringOptionalExample: OK

successbooleanOptionalExample: true

400

Bad request

application/json

402

Insufficient credits

application/json

404

Not found

application/json

get/twitter/tweet/{id}

GET /twitter/tweet/{id} HTTP/1.1
Host: api.pullbay.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "requestId": "3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24",
  "status": 200,
  "message": "OK",
  "success": true,
  "data": [
    {
      "type": "tweet",
      "id": "20",
      "url": "https://x.com/jack/status/20",
      "twitterUrl": "https://twitter.com/jack/status/20",
      "text": "just setting up my twttr",
      "fullText": "just setting up my twttr",
      "source": "Twitter Web Client",
      "lang": "en",
      "createdAt": "Tue Mar 21 20:50:14 +0000 2006",
      "conversationId": "20",
      "retweetCount": 126541,
      "replyCount": 17858,
      "likeCount": 309719,
      "quoteCount": 6384,
      "bookmarkCount": 21386,
      "viewCount": null,
      "isReply": false,
      "isPinned": false,
      "isRetweet": false,
      "isQuote": false,
      "author": {
        "type": "user",
        "id": "44196397",
        "userName": "elonmusk",
        "name": "Elon Musk",
        "url": "https://x.com/elonmusk",
        "twitterUrl": "https://twitter.com/elonmusk",
        "description": "https://t.co/dDtDyVssfm",
        "location": "",
        "profilePicture": "https://pbs.twimg.com/profile_images/2035314704307081216/71U1ftM3_normal.jpg",
        "coverPicture": "https://pbs.twimg.com/profile_banners/44196397/1774145451",
        "isVerified": true,
        "isBlueVerified": true,
        "protected": false,
        "canDm": false,
        "canMediaTag": false,
        "followers": 239698341,
        "following": 1319,
        "fastFollowersCount": 0,
        "favouritesCount": 225074,
        "listedCount": 168631,
        "mediaCount": 4467,
        "statusesCount": 101980,
        "createdAt": "Tue Jun 02 20:12:29 +0000 2009",
        "status": ""
      },
      "media": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ]
    }
  ],
  "pricing": {
    "creditsCharged": 5
  }
}

Get a user by handle

get

Returns a Twitter user by handle (without @).

Cost: 40 credits/request + 1 credit/item

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

handlestring · min: 1 · max: 100RequiredExample: elonmusk

Responses

200

Successful request

application/json

requestIdstring · uuidOptionalExample: 3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24

statusintegerOptionalExample: 200

messagestringOptionalExample: OK

successbooleanOptionalExample: true

400

Bad request

application/json

402

Insufficient credits

application/json

404

Not found

application/json

get/twitter/handle/{handle}

GET /twitter/handle/{handle} HTTP/1.1
Host: api.pullbay.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "requestId": "3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24",
  "status": 200,
  "message": "OK",
  "success": true,
  "data": [
    {
      "type": "user",
      "id": "44196397",
      "userName": "elonmusk",
      "name": "Elon Musk",
      "url": "https://x.com/elonmusk",
      "twitterUrl": "https://twitter.com/elonmusk",
      "description": "https://t.co/dDtDyVssfm",
      "location": "",
      "profilePicture": "https://pbs.twimg.com/profile_images/2035314704307081216/71U1ftM3_normal.jpg",
      "coverPicture": "https://pbs.twimg.com/profile_banners/44196397/1774145451",
      "isVerified": true,
      "isBlueVerified": true,
      "protected": false,
      "canDm": false,
      "canMediaTag": false,
      "followers": 239698341,
      "following": 1319,
      "fastFollowersCount": 0,
      "favouritesCount": 225074,
      "listedCount": 168631,
      "mediaCount": 4467,
      "statusesCount": 101980,
      "createdAt": "Tue Jun 02 20:12:29 +0000 2009",
      "status": ""
    }
  ],
  "pricing": {
    "creditsCharged": 41
  }
}

Get a user about by handle

get

Returns the about/bio details for a Twitter user by handle.

Cost: 2 credits/request + 1 credit/item

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

handlestring · min: 1 · max: 100RequiredExample: elonmusk

Responses

200

Successful request

application/json

requestIdstring · uuidOptionalExample: 3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24

statusintegerOptionalExample: 200

messagestringOptionalExample: OK

successbooleanOptionalExample: true

400

Bad request

application/json

402

Insufficient credits

application/json

404

Not found

application/json

get/twitter/handle/{handle}/about

GET /twitter/handle/{handle}/about HTTP/1.1
Host: api.pullbay.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "requestId": "3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24",
  "status": 200,
  "message": "OK",
  "success": true,
  "data": [
    {
      "accountBasedIn": "United States",
      "locationAccurate": true,
      "profileImageShape": "Circle",
      "avatarUrl": "https://pbs.twimg.com/profile_images/2035314704307081216/71U1ftM3_normal.jpg",
      "usernameChangeCount": "0",
      "accountCreatedAt": "Tue Jun 02 20:12:29 +0000 2009",
      "accountSource": "United States App Store",
      "verifiedSince": "-156836000000000"
    }
  ],
  "pricing": {
    "creditsCharged": 3
  }
}

Get a user by ID

get

Returns a Twitter user by their numeric user ID.

Cost: 40 credits/request + 1 credit/item

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · min: 1 · max: 100RequiredExample: 44196397

Responses

200

Successful request

application/json

requestIdstring · uuidOptionalExample: 3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24

statusintegerOptionalExample: 200

messagestringOptionalExample: OK

successbooleanOptionalExample: true

400

Bad request

application/json

402

Insufficient credits

application/json

404

Not found

application/json

get/twitter/user/{id}

GET /twitter/user/{id} HTTP/1.1
Host: api.pullbay.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "requestId": "3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24",
  "status": 200,
  "message": "OK",
  "success": true,
  "data": [
    {
      "type": "user",
      "id": "44196397",
      "userName": "elonmusk",
      "name": "Elon Musk",
      "url": "https://x.com/elonmusk",
      "twitterUrl": "https://twitter.com/elonmusk",
      "description": "https://t.co/dDtDyVssfm",
      "location": "",
      "profilePicture": "https://pbs.twimg.com/profile_images/2035314704307081216/71U1ftM3_normal.jpg",
      "coverPicture": "https://pbs.twimg.com/profile_banners/44196397/1774145451",
      "isVerified": true,
      "isBlueVerified": true,
      "protected": false,
      "canDm": false,
      "canMediaTag": false,
      "followers": 239698341,
      "following": 1319,
      "fastFollowersCount": 0,
      "favouritesCount": 225074,
      "listedCount": 168631,
      "mediaCount": 4467,
      "statusesCount": 101980,
      "createdAt": "Tue Jun 02 20:12:29 +0000 2009",
      "status": ""
    }
  ],
  "pricing": {
    "creditsCharged": 41
  }
}

Get tweets posted by a user

get

Returns tweets posted by a user, by user ID. Use cursor to paginate or maxItems for a one-shot bulk pull (mutually exclusive).

Cost: 160 credits/request + 1 credit/item

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstring · min: 1 · max: 100RequiredExample: 44196397

Query parameters

maxItemsinteger · min: 1 · max: 200Optional

cursorstringOptional

Responses

200

Successful request

application/json

requestIdstring · uuidOptionalExample: 3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24

statusintegerOptionalExample: 200

messagestringOptionalExample: OK

successbooleanOptionalExample: true

400

Bad request

application/json

402

Insufficient credits

application/json

404

Not found

application/json

get/twitter/user/{id}/tweets

GET /twitter/user/{id}/tweets HTTP/1.1
Host: api.pullbay.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "requestId": "3b8dcb68-1f8c-4a7b-b9e7-63a7b9986f24",
  "status": 200,
  "message": "OK",
  "success": true,
  "data": [
    {
      "type": "tweet",
      "id": "20",
      "url": "https://x.com/jack/status/20",
      "twitterUrl": "https://twitter.com/jack/status/20",
      "text": "just setting up my twttr",
      "fullText": "just setting up my twttr",
      "source": "Twitter Web Client",
      "lang": "en",
      "createdAt": "Tue Mar 21 20:50:14 +0000 2006",
      "conversationId": "20",
      "retweetCount": 126541,
      "replyCount": 17858,
      "likeCount": 309719,
      "quoteCount": 6384,
      "bookmarkCount": 21386,
      "viewCount": null,
      "isReply": false,
      "isPinned": false,
      "isRetweet": false,
      "isQuote": false,
      "author": {
        "type": "user",
        "id": "44196397",
        "userName": "elonmusk",
        "name": "Elon Musk",
        "url": "https://x.com/elonmusk",
        "twitterUrl": "https://twitter.com/elonmusk",
        "description": "https://t.co/dDtDyVssfm",
        "location": "",
        "profilePicture": "https://pbs.twimg.com/profile_images/2035314704307081216/71U1ftM3_normal.jpg",
        "coverPicture": "https://pbs.twimg.com/profile_banners/44196397/1774145451",
        "isVerified": true,
        "isBlueVerified": true,
        "protected": false,
        "canDm": false,
        "canMediaTag": false,
        "followers": 239698341,
        "following": 1319,
        "fastFollowersCount": 0,
        "favouritesCount": 225074,
        "listedCount": 168631,
        "mediaCount": 4467,
        "statusesCount": 101980,
        "createdAt": "Tue Jun 02 20:12:29 +0000 2009",
        "status": ""
      },
      "media": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "hasNextPage": null,
    "cursor": null,
    "offset": null
  },
  "pricing": {
    "creditsCharged": 161
  }
}