Skip to main content

Beam

Please note: This is an introductory reference

For the most up-to-date information, refer to the API Reference.
🚧 The information provided in this section cannot be programmatically updated and may be subject to inconsistencies over time.

Beam Endpoints
  • Testnet: http://platform.canary.enjin.io/graphql/beam
  • Mainnet: http://platform.enjin.io/graphql/beam

This is a detailed reference guide that explains the most commonly used operations.

GetBeam​

The GetBeam query retrieves detailed information about a specific Enjin Beam

. A Beam is a feature provided by Enjin that allows users to claim blockchain assets via QR codes. This query is essential for applications that need to access and display information about a particular Beam or track its usage.

query GetBeam {
  GetBeam(code: "0dd3694f2c4599179f08686539cd73dc") {
    id
    code
    name
    description
    image
    start
    end
    isClaimable
    claimsRemaining    
    qr {
      url
      payload
    }
    message {
      walletPublicKey
      message
    }
    collection {
      collectionId
      maxTokenCount
      maxTokenSupply
      forceSingleMint
      frozen
      network
    }    
  }
}

GetBeams​

The GetBeams query is used to retrieve an array of beam details, optionally filtered by codes or names. This query is particularly useful for applications that need to fetch information about multiple Beams at once, making it easier to manage and display Beam data.

query GetBeams {
  GetBeams(codes: ["0dd3694f2c4599179f08686539cd73dc"]) {
    totalCount
    pageInfo {
      hasPreviousPage
      hasNextPage
      startCursor
      endCursor
    }
    edges {
      node {
        id
        code
        name
        description
        image
        start
        end
        isClaimable
        qr {
          url
          payload
        }
        collection {
          collectionId
          maxTokenCount
          maxTokenSupply
          forceSingleMint
          frozen
          network
        }
        claims {
          totalCount
          pageInfo {
            hasPreviousPage
            hasNextPage
            startCursor
            endCursor
          }
          edges {
            node {
              id
              claimedAt
              claimStatus
              quantity
              code
              wallet {
                account {
                  publicKey
                  address
                }
              }
              collection {
                collectionId
                maxTokenCount
                maxTokenSupply
                forceSingleMint
                frozen
                network
              }
            }
          }
        }
      }
    }
  }
}

GetClaims​

The GetClaims query is used to retrieve an array of claim details from a system, and it allows for optional filtering based on claim IDs, codes, accounts, or states. This query is typically used to track and manage claims associated with specific assets or codes in a system.

query GetClaims {
  GetClaims(
    codes: ["0dd3694f2c4599179f08686539cd73dc"]
  ) {
    edges {
      cursor
      node {
        id
        claimedAt
        claimStatus
        quantity
        wallet {
          account {
            publicKey
            address
          }
        }
        collection {
          collectionId
          maxTokenCount
          maxTokenSupply
          forceSingleMint
          frozen
          network
        }
        beam {
          id
          code          
        }
      }
    }
    totalCount
    pageInfo {
      startCursor
      endCursor
      hasPreviousPage
      hasNextPage
    }
  }
}

GetSingleUseCodes​

The GetClaims query retrieves an array of claim details, optionally filtered by claim IDs, claim codes, accounts, or claim states. It is designed to provide information about claims associated with a specific code.

query GetSingleUseCodes {
  GetSingleUseCodes(code: "7cd390ab3d56c42b818d0a1aa2221c8f") {
    edges {
      cursor
      node {
        code
        qr {
          url
          payload
        }
      }
    }
    totalCount
    pageInfo {
      hasPreviousPage
      hasNextPage
      startCursor
      endCursor
    }
  }
}