Draws

Run giveaway draw

Checks credits, then draws winners from inspected replies & reposters. Remaining credits cap the candidates.

post/draws

Headers

Idempotency-Keystring

Generate 1 unique value per intended request. Reuse it only to retry the same request. Exact retries return the original result & charge nothing.

Request body

tweetUrlstring uri required

winnerCountinteger

backupCountinteger

uniqueAuthorsOnlyboolean

mustRetweetboolean

mustFollowUsernamestring

filterMinFollowersinteger

filterAccountAgeDaysinteger

filterLanguagestring

requiredHashtagsstring[]

requiredKeywordsstring[]

requiredMentionsstring[]

Example request

{
  "tweetUrl": "https://x.com/elonmusk/status/1234567890",
  "winnerCount": 3,
  "backupCount": 2,
  "uniqueAuthorsOnly": true,
  "mustRetweet": true,
  "mustFollowUsername": "elonmusk",
  "filterMinFollowers": 50,
  "filterAccountAgeDays": 30,
  "filterLanguage": "en",
  "requiredHashtags": [
    "#giveaway"
  ],
  "requiredKeywords": [
    "entered"
  ],
  "requiredMentions": [
    "@elonmusk"
  ]
}

Response

Draw completed

idstring required

tweetIdstring required

totalEntriesinteger required

Entries inspected after the credit cap, which can be fewer than the post's replies.

validEntriesinteger required

Inspected entries that passed every filter. A credit cap can leave valid replies uninspected.

Example response

{
  "id": "f4bd00a2-7b4e-4e59-8e1b-72e2c9f12345",
  "tweetId": "1234567890",
  "totalEntries": 250,
  "validEntries": 200,
  "winners": []
}