Sign in

v11

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0112893437.0 KB
Draws

Run giveaway draw

Runs a giveaway draw from a source tweet. The draw first checks the minimum credits needed to inspect the source tweet and at least one candidate. Remaining credits cap how many replies and retweeters can be inspected before filters and winner selection run.

post/draws

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

Candidate entries inspected for this draw after the credit-derived cap. This may be lower than the source tweet's full reply count.

validEntriesinteger required

Entries from the inspected candidate set that passed all filters. This is not necessarily every valid reply on the source tweet when credits cap inspection.

Example response

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