Set the rule and get the rusult of the rule for airdrop.

GraphQL API

  • Query String
  • Query Variables
  • HTTP Headers

HTTP Request and Response

Request

  • URL
    • For development: https://test.fstk.io/api
    • For production: https://engine.fstk.io/api
  • Method: POST
  • Headers
    • accept: application/json
    • content-type: application/json
    • authorization: Bearer [JWT Web-to-Server access token]
      • (for example)
  • Body

    The value of query in the body is a String.

Response

Parameters

Request

  • rule <[airdropLocateRule]!>
    • type <enum LocateRuleEnum!>
      • EVERY or AT_LEASTEVERY means every condition will be counted for giveaway item calculation. e.g. If qualification is set to be ‘every’ 1 FST can receive 1 FVoucher, a funder who owns 10 FST can receive 10 FVoucher through this airdrop event. AT_LEAST means only the condition is greater than or equal to (>=) the qualification will be counted for giveaway item calculation. e.g. If qualification is set to be ‘at least’ 5 FST can receive 1 FVoucher, a funder who owns 10 FST can receive 1 FVoucher through this airdrop event.
    • itemId <ID!>
      • Item(Smart Token/Voucher) of the rule.
    • amount <string!>
      • Amount of item(Smart Token/Voucher) of the rule.
  • itemID <string>
    • Item(Smart Token/Voucher) to drop.
  • amount <string>
    • Amount of item(Smart Token/Voucher) to drop if matching the condition.

Response

  • airdropLocate <AirdropLocate!>
    • id <ID!>
      • ID of the locate rules.
    • airdropItem <AirdropItem!>
      • id <ID!>
        • ID of the item(Smart Token/Voucher) which is to drop.
      • name <String!>
        • Name of the item(Smart Token/Voucher) which is to drop.
      • decimals <String!>
        • Decimals of the item(Smart Token/Voucher) which is to drop.
    • totalAddresses <String>
      • Amount of accounts which are match to the rules.
    • totalAirdropAmount <String>
      • Total amount(addition of each rule’s amount) of the item(Smart Token/Voucher) to drop. The format is Decimaled Number.
    • summery <[AirdropLocateResult]!>
      • rule <AirdropLocateRule!>
        • locateRule <LocateRule>
          • type <LocateRuleEnum>
            • EVERY or AT_LEAST. <enum>
          • item <Token> or <Voucher>
            • decimals <String>
              • Decimals of the item(Smart Token/Voucher) of the rule.
        • item <Token> or <Voucher>
          • decimals <String>
            • Decimals of the item(Smart Token/Voucher) which to drop.
      • totalAddresses <String>
        • Total amount of account match the rule. The format is Decimaled Number.
      • totalAirdropAmount <String>
        • Total amount of the item(Smart Token/Voucher) to drop. The format is Decimaled Number.