Skip to content

Raccoona-Founders/quiz-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 

Repository files navigation

Quiz service API Documentation

1. QuizPhrase format

QuizPhrase is a unique list of words separated by space. Each word has to be lowercased, with any meaning and length, contained by symbols [a-z], [а-я] and digits. QuizPhrase can be 4 words minimun.

Examples

quize 9083 kilovay puppy over9000

lol watter bitcoin plark awesome quiz quiz a superthot

2. Check QuizPhrase

Request

POST /quiz/check
{
  "quizPhrase": "lol watter bitcoin plark awesome"
}

✅ Response if Phrase exists and ready to redeem

HTTP 200
{
  "currency": "BTC",    # cryptocurrency asset (BTC, DASH, ETH, etc.)
  "amount": 0.002924    # amount
}

❌ Response if Phrase exists and already redeemed/expired

HTTP 400: QuizPhrase expired
HTTP 400: QuizPhrase redeemed

❌ Response if Phrase not exists

HTTP 404: QuizPhrase not found

❌ Response if out of limit (anti spam)

HTTP 429: Out of limit

3. Redeem QuizPhrase

Request

POST /quiz/redeem
{
  "quizPhrase": "lol watter bitcoin plark awesome",   # QuizPhrase
  "address": "1kd72...."                              # Bitcoin address
}

✅ Response if successful redeemed

HTTP 200
{
  "txid": "as834jcx989dfsdf..." # TXID of transansation
  "currency": "BTC"
}

❌ Responses on error

HTTP 400: Invalid address
HTTP 400: QuizPhrase already redeemed
HTTP 404: QuizPhrase does not exists

4. Check status

Request

GET /quiz/status

✅ Response if Phrase exists and ready to redeem

HTTP 200
{
  "ok": true
}

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published