Saturn GraphQL API Documentation

Welcome to the Saturn GraphQL API Documentation. This reference includes the complete set of GraphQL types, queries, and mutations to build NFT Projects. These APIs include creating and updating NFT Projects, NFTs, and Whitelists as well as creating multisig minting transactions.

Starting a traditional NFT Project mint requires calling the CreateRoyaltyMintTransaction mutation followed by the SubmitRoyaltyMintTransaction mutation (even with no hexTransaction).

If you would like detailed, copy and pastable examples on how to use these APIs, they can be found in the Saturn API Example Repository which details exactly how to use these APIs to do everything from creating an NFT Project to Minting NFTs!

API Endpoints
# Production:
https://api.saturnnft.io/graphql
# Preprod:
https://api.preprod.saturnnft.io/graphql
Headers
# Your API token from the dashboard. Must be included in all API calls.
Authorization: Bearer <YOUR_TOKEN_HERE>
Version

1.0.0

Queries

buyRandomMintPayment

Response

Returns a GetBuyRandomMintPaymentPayload!

Arguments
Name Description
input - GetBuyRandomMintPaymentInput!

Example

Query
query buyRandomMintPayment($input: GetBuyRandomMintPaymentInput!) {
  buyRandomMintPayment(input: $input) {
    id
    name
    blockchain
    network
    policyId
    reservedNFTs
    completedNFTs
    totalNFTs
    prices {
      adaPrice
      allowAdaPayment
      tokenPrices {
        ...NFTPaymentTokenPriceFragment
      }
      isMainPrice
    }
    maxPerTx
    maxPerWallet
    mintStart
    mintEnd
    lockAfterDatetime
    isActive
    isFreeMint
    error {
      message
      code
    }
  }
}
Variables
{"input": GetBuyRandomMintPaymentInput}
Response
{
  "data": {
    "buyRandomMintPayment": {
      "id": "ae81681e-4887-4a35-bd77-575da9353596",
      "name": "abc123",
      "blockchain": "NONE",
      "network": "PREPROD",
      "policyId": "abc123",
      "reservedNFTs": 456,
      "completedNFTs": 456,
      "totalNFTs": 456,
      "prices": [NFTPaymentPrice],
      "maxPerTx": 456,
      "maxPerWallet": 456,
      "mintStart": "2007-12-03T10:15:30Z",
      "mintEnd": "2007-12-03T10:15:30Z",
      "lockAfterDatetime": "2007-12-03T10:15:30Z",
      "isActive": true,
      "isFreeMint": true,
      "error": SaturnError
    }
  }
}

buyRandomMintPurchases

Arguments
Name Description
input - GetBuyRandomMintPurchasesInput!

Example

Query
query buyRandomMintPurchases($input: GetBuyRandomMintPurchasesInput!) {
  buyRandomMintPurchases(input: $input) {
    nftProjectId
    address
    purchasedNFTs {
      name
      image
    }
    error {
      message
      code
    }
  }
}
Variables
{"input": GetBuyRandomMintPurchasesInput}
Response
{
  "data": {
    "buyRandomMintPurchases": {
      "nftProjectId": "xyz789",
      "address": "abc123",
      "purchasedNFTs": [PurchaseNFT],
      "error": SaturnError
    }
  }
}

nFT

Response

Returns an GetNFTPayload!

Arguments
Name Description
id - String!

Example

Query
query nFT($id: String!) {
  nFT(id: $id) {
    nft {
      id
      nft_project_id
      nft_project {
        ...NFTProjectFragment
      }
      nft_mint {
        ...NFTMintFragment
      }
      nft_burn {
        ...NFTBurnFragment
      }
      collection_id
      policy_id
      asset_name
      name
      media_type
      image
      files {
        ...NFTFileFragment
      }
      json_properties
      individual_price {
        ...PriceFragment
      }
      created_at
      updated_at
    }
    error {
      message
      code
    }
  }
}
Variables
{"id": "xyz789"}
Response
{
  "data": {
    "nFT": {
      "nft": NFT,
      "error": SaturnError
    }
  }
}

nFTGenerator

Response

Returns an GetNFTGeneratorPayload!

Example

Query
query nFTGenerator {
  nFTGenerator {
    nftGenerator {
      id
      nft_project_id
      nft_project {
        ...NFTProjectFragment
      }
      nft_layers {
        ...NFTLayerFragment
      }
      created_at
      updated_at
    }
    error {
      message
      code
    }
  }
}
Response
{
  "data": {
    "nFTGenerator": {
      "nftGenerator": NFTGenerator,
      "error": SaturnError
    }
  }
}

nFTProject

Response

Returns an NFTProject

Arguments
Name Description
id - String!

Example

Query
query nFTProject($id: String!) {
  nFTProject(id: $id) {
    id
    account_id
    name
    collection_id
    blockchain
    network
    policy_id
    max_count
    nfts {
      pageInfo {
        ...PageInfoFragment
      }
      edges {
        ...NftsEdgeFragment
      }
      nodes {
        ...NFTFragment
      }
      totalCount
    }
    nft_project_mint {
      id
      nft_project_id
      nft_project {
        ...NFTProjectFragment
      }
      mint_type
      mint_start
      mint_end
      platform_fee_percent
      min_platform_fee
      partner_fee_percent
      min_partner_fee
      is_free_mint
      prices {
        ...PriceFragment
      }
      max_per_transaction
      max_per_wallet
      has_blob_at_mint_start
      max_whitelists
      whitelists {
        ...WhitelistFragment
      }
      has_public_mint
      public_start_time
      created_at
      updated_at
    }
    nft_project_royalty {
      id
      nft_project_id
      nft_project {
        ...NFTProjectFragment
      }
      royalty_address
      royalty_percent
      mint_address
      mint_tx_hash
      mint_tx
      mint_tx_fee
      mint_tx_size
      mint_datetime
      return_address
      burn_tx_hash
      burn_tx
      burn_tx_fee
      burn_tx_size
      burn_datetime
      mint_status
      created_at
      updated_at
    }
    nft_generator {
      id
      nft_project_id
      nft_project {
        ...NFTProjectFragment
      }
      nft_layers {
        ...NFTLayerFragment
      }
      created_at
      updated_at
    }
    wallet {
      id
      account_id
      nft_project_id
      nft_project {
        ...NFTProjectFragment
      }
      name
      blockchain
      network
      address
      is_payment
      mnemonic
      key_type
      public_key
      private_key
      public_payment_key
      private_payment_key
      public_stake_key
      private_stake_key
      account_index
      key_index
      wallet_type
      created_at
      updated_at
    }
    lock_after_datetime
    deleted_at
    nft_project_address
    created_at
    updated_at
  }
}
Variables
{"id": "abc123"}
Response
{
  "data": {
    "nFTProject": {
      "id": "ae81681e-4887-4a35-bd77-575da9353596",
      "account_id": "ae81681e-4887-4a35-bd77-575da9353596",
      "name": "abc123",
      "collection_id": 456,
      "blockchain": "NONE",
      "network": "PREPROD",
      "policy_id": "xyz789",
      "max_count": 456,
      "nfts": NftsConnection,
      "nft_project_mint": NFTProjectMint,
      "nft_project_royalty": NFTProjectRoyalty,
      "nft_generator": NFTGenerator,
      "wallet": Wallet,
      "lock_after_datetime": "2007-12-03T10:15:30Z",
      "deleted_at": "2007-12-03T10:15:30Z",
      "nft_project_address": "xyz789",
      "created_at": "2007-12-03T10:15:30Z",
      "updated_at": "2007-12-03T10:15:30Z"
    }
  }
}

nFTProjects

Response

Returns an NFTProjectsConnection

Arguments
Name Description
first - Int Returns the first n elements from the list.
after - String Returns the elements in the list that come after the specified cursor.
last - Int Returns the last n elements from the list.
before - String Returns the elements in the list that come before the specified cursor.

Example

Query
query nFTProjects(
  $first: Int,
  $after: String,
  $last: Int,
  $before: String
) {
  nFTProjects(
    first: $first,
    after: $after,
    last: $last,
    before: $before
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      cursor
      node {
        ...NFTProjectFragment
      }
    }
    nodes {
      id
      account_id
      name
      collection_id
      blockchain
      network
      policy_id
      max_count
      nfts {
        ...NftsConnectionFragment
      }
      nft_project_mint {
        ...NFTProjectMintFragment
      }
      nft_project_royalty {
        ...NFTProjectRoyaltyFragment
      }
      nft_generator {
        ...NFTGeneratorFragment
      }
      wallet {
        ...WalletFragment
      }
      lock_after_datetime
      deleted_at
      nft_project_address
      created_at
      updated_at
    }
    totalCount
  }
}
Variables
{
  "first": 987,
  "after": "abc123",
  "last": 123,
  "before": "abc123"
}
Response
{
  "data": {
    "nFTProjects": {
      "pageInfo": PageInfo,
      "edges": [NFTProjectsEdge],
      "nodes": [NFTProject],
      "totalCount": 987
    }
  }
}

nFTs

Response

Returns an NFTsConnection

Arguments
Name Description
input - GetNFTsInput!
first - Int Returns the first n elements from the list.
after - String Returns the elements in the list that come after the specified cursor.
last - Int Returns the last n elements from the list.
before - String Returns the elements in the list that come before the specified cursor.

Example

Query
query nFTs(
  $input: GetNFTsInput!,
  $first: Int,
  $after: String,
  $last: Int,
  $before: String
) {
  nFTs(
    input: $input,
    first: $first,
    after: $after,
    last: $last,
    before: $before
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      cursor
      node {
        ...NFTFragment
      }
    }
    nodes {
      id
      nft_project_id
      nft_project {
        ...NFTProjectFragment
      }
      nft_mint {
        ...NFTMintFragment
      }
      nft_burn {
        ...NFTBurnFragment
      }
      collection_id
      policy_id
      asset_name
      name
      media_type
      image
      files {
        ...NFTFileFragment
      }
      json_properties
      individual_price {
        ...PriceFragment
      }
      created_at
      updated_at
    }
    totalCount
  }
}
Variables
{
  "input": GetNFTsInput,
  "first": 987,
  "after": "xyz789",
  "last": 123,
  "before": "xyz789"
}
Response
{
  "data": {
    "nFTs": {
      "pageInfo": PageInfo,
      "edges": [NFTsEdge],
      "nodes": [NFT],
      "totalCount": 987
    }
  }
}

whitelists

Response

Returns a GetWhitelistPayload!

Arguments
Name Description
input - GetWhitelistInput!

Example

Query
query whitelists($input: GetWhitelistInput!) {
  whitelists(input: $input) {
    whitelists {
      id
      nft_project_mint_id
      nft_project_mint {
        ...NFTProjectMintFragment
      }
      whitelist_type
      name
      collection_id
      start_time
      end_time
      max_nfts_per_slot
      whitelist_prices {
        ...PriceFragment
      }
      required_policy_id
      required_owned_amount
      whitelist_slots {
        ...WhitelistSlotFragment
      }
      whitelist_started_time
      whitelist_ended_time
      created_at
      updated_at
    }
    error {
      message
      code
    }
  }
}
Variables
{"input": GetWhitelistInput}
Response
{
  "data": {
    "whitelists": {
      "whitelists": [Whitelist],
      "error": SaturnError
    }
  }
}

Mutations

addNFTProjects

Response

Returns an AddNFTProjectsPayload!

Example

Query
mutation addNFTProjects {
  addNFTProjects {
    nftProject {
      id
      account_id
      name
      collection_id
      blockchain
      network
      policy_id
      max_count
      nfts {
        ...NftsConnectionFragment
      }
      nft_project_mint {
        ...NFTProjectMintFragment
      }
      nft_project_royalty {
        ...NFTProjectRoyaltyFragment
      }
      nft_generator {
        ...NFTGeneratorFragment
      }
      wallet {
        ...WalletFragment
      }
      lock_after_datetime
      deleted_at
      nft_project_address
      created_at
      updated_at
    }
    error {
      message
      code
    }
  }
}
Response
{
  "data": {
    "addNFTProjects": {
      "nftProject": NFTProject,
      "error": SaturnError
    }
  }
}

addNFTs

Response

Returns an AddNFTsPayload!

Arguments
Name Description
input - AddNFTsInput!

Example

Query
mutation addNFTs($input: AddNFTsInput!) {
  addNFTs(input: $input) {
    nfts {
      id
      nft_project_id
      nft_project {
        ...NFTProjectFragment
      }
      nft_mint {
        ...NFTMintFragment
      }
      nft_burn {
        ...NFTBurnFragment
      }
      collection_id
      policy_id
      asset_name
      name
      media_type
      image
      files {
        ...NFTFileFragment
      }
      json_properties
      individual_price {
        ...PriceFragment
      }
      created_at
      updated_at
    }
    error {
      message
      code
    }
  }
}
Variables
{"input": AddNFTsInput}
Response
{
  "data": {
    "addNFTs": {
      "nfts": [NFT],
      "error": SaturnError
    }
  }
}

addWhitelist

Response

Returns an AddWhitelistPayload!

Arguments
Name Description
input - AddWhitelistInput!

Example

Query
mutation addWhitelist($input: AddWhitelistInput!) {
  addWhitelist(input: $input) {
    whitelists {
      id
      nft_project_mint_id
      nft_project_mint {
        ...NFTProjectMintFragment
      }
      whitelist_type
      name
      collection_id
      start_time
      end_time
      max_nfts_per_slot
      whitelist_prices {
        ...PriceFragment
      }
      required_policy_id
      required_owned_amount
      whitelist_slots {
        ...WhitelistSlotFragment
      }
      whitelist_started_time
      whitelist_ended_time
      created_at
      updated_at
    }
    error {
      message
      code
    }
  }
}
Variables
{"input": AddWhitelistInput}
Response
{
  "data": {
    "addWhitelist": {
      "whitelists": [Whitelist],
      "error": SaturnError
    }
  }
}

cancelBuyDirectMintTransaction

Arguments
Name Description
input - CancelBuyDirectMintTransactionInput!

Example

Query
mutation cancelBuyDirectMintTransaction($input: CancelBuyDirectMintTransactionInput!) {
  cancelBuyDirectMintTransaction(input: $input) {
    nftProjectId
    error {
      message
      code
    }
  }
}
Variables
{"input": CancelBuyDirectMintTransactionInput}
Response
{
  "data": {
    "cancelBuyDirectMintTransaction": {
      "nftProjectId": "abc123",
      "error": SaturnError
    }
  }
}

cancelBuyRandomMintTransaction

Arguments
Name Description
input - CancelBuyRandomMintTransactionInput!

Example

Query
mutation cancelBuyRandomMintTransaction($input: CancelBuyRandomMintTransactionInput!) {
  cancelBuyRandomMintTransaction(input: $input) {
    nftProjectId
    error {
      message
      code
    }
  }
}
Variables
{"input": CancelBuyRandomMintTransactionInput}
Response
{
  "data": {
    "cancelBuyRandomMintTransaction": {
      "nftProjectId": "xyz789",
      "error": SaturnError
    }
  }
}

cancelSingleOrBulkBurnTransaction

Arguments
Name Description
input - CancelSingleOrBulkBurnTransactionInput!

Example

Query
mutation cancelSingleOrBulkBurnTransaction($input: CancelSingleOrBulkBurnTransactionInput!) {
  cancelSingleOrBulkBurnTransaction(input: $input) {
    nftProjectId
    error {
      message
      code
    }
  }
}
Variables
{"input": CancelSingleOrBulkBurnTransactionInput}
Response
{
  "data": {
    "cancelSingleOrBulkBurnTransaction": {
      "nftProjectId": "xyz789",
      "error": SaturnError
    }
  }
}

cancelSingleOrBulkMintTransaction

Arguments
Name Description
input - CancelSingleOrBulkMintTransactionInput!

Example

Query
mutation cancelSingleOrBulkMintTransaction($input: CancelSingleOrBulkMintTransactionInput!) {
  cancelSingleOrBulkMintTransaction(input: $input) {
    nftProjectId
    error {
      message
      code
    }
  }
}
Variables
{"input": CancelSingleOrBulkMintTransactionInput}
Response
{
  "data": {
    "cancelSingleOrBulkMintTransaction": {
      "nftProjectId": "abc123",
      "error": SaturnError
    }
  }
}

createBuyDirectMintTransaction

Arguments
Name Description
input - CreateBuyDirectMintTransactionInput!

Example

Query
mutation createBuyDirectMintTransaction($input: CreateBuyDirectMintTransactionInput!) {
  createBuyDirectMintTransaction(input: $input) {
    hexTransaction
    error {
      message
      code
    }
  }
}
Variables
{"input": CreateBuyDirectMintTransactionInput}
Response
{
  "data": {
    "createBuyDirectMintTransaction": {
      "hexTransaction": "xyz789",
      "error": SaturnError
    }
  }
}

createBuyRandomMintTransaction

Arguments
Name Description
input - CreateBuyRandomMintTransactionInput!

Example

Query
mutation createBuyRandomMintTransaction($input: CreateBuyRandomMintTransactionInput!) {
  createBuyRandomMintTransaction(input: $input) {
    hexTransaction
    error {
      message
      code
    }
  }
}
Variables
{"input": CreateBuyRandomMintTransactionInput}
Response
{
  "data": {
    "createBuyRandomMintTransaction": {
      "hexTransaction": "xyz789",
      "error": SaturnError
    }
  }
}

createRoyaltyMintTransaction

Arguments
Name Description
input - CreateRoyaltyMintTransactionInput!

Example

Query
mutation createRoyaltyMintTransaction($input: CreateRoyaltyMintTransactionInput!) {
  createRoyaltyMintTransaction(input: $input) {
    hexTransaction
    error {
      message
      code
    }
  }
}
Variables
{"input": CreateRoyaltyMintTransactionInput}
Response
{
  "data": {
    "createRoyaltyMintTransaction": {
      "hexTransaction": "abc123",
      "error": SaturnError
    }
  }
}

createSingleOrBulkBurnTransaction

Arguments
Name Description
input - CreateSingleOrBulkBurnTransactionInput!

Example

Query
mutation createSingleOrBulkBurnTransaction($input: CreateSingleOrBulkBurnTransactionInput!) {
  createSingleOrBulkBurnTransaction(input: $input) {
    hexTransaction
    error {
      message
      code
    }
  }
}
Variables
{"input": CreateSingleOrBulkBurnTransactionInput}
Response
{
  "data": {
    "createSingleOrBulkBurnTransaction": {
      "hexTransaction": "xyz789",
      "error": SaturnError
    }
  }
}

createSingleOrBulkMintTransaction

Arguments
Name Description
input - CreateSingleOrBulkMintTransactionInput!

Example

Query
mutation createSingleOrBulkMintTransaction($input: CreateSingleOrBulkMintTransactionInput!) {
  createSingleOrBulkMintTransaction(input: $input) {
    hexTransaction
    error {
      message
      code
    }
  }
}
Variables
{"input": CreateSingleOrBulkMintTransactionInput}
Response
{
  "data": {
    "createSingleOrBulkMintTransaction": {
      "hexTransaction": "xyz789",
      "error": SaturnError
    }
  }
}

deleteAllNFTs

Response

Returns an DeleteAllNFTsPayload!

Arguments
Name Description
input - DeleteAllNFTsInput!

Example

Query
mutation deleteAllNFTs($input: DeleteAllNFTsInput!) {
  deleteAllNFTs(input: $input) {
    nftProject {
      id
      account_id
      name
      collection_id
      blockchain
      network
      policy_id
      max_count
      nfts {
        ...NftsConnectionFragment
      }
      nft_project_mint {
        ...NFTProjectMintFragment
      }
      nft_project_royalty {
        ...NFTProjectRoyaltyFragment
      }
      nft_generator {
        ...NFTGeneratorFragment
      }
      wallet {
        ...WalletFragment
      }
      lock_after_datetime
      deleted_at
      nft_project_address
      created_at
      updated_at
    }
    error {
      message
      code
    }
  }
}
Variables
{"input": DeleteAllNFTsInput}
Response
{
  "data": {
    "deleteAllNFTs": {
      "nftProject": NFTProject,
      "error": SaturnError
    }
  }
}

deleteNFTProjects

Response

Returns an DeleteNFTProjectsPayload!

Arguments
Name Description
input - DeleteNFTProjectsInput!

Example

Query
mutation deleteNFTProjects($input: DeleteNFTProjectsInput!) {
  deleteNFTProjects(input: $input) {
    nftProjects {
      id
      account_id
      name
      collection_id
      blockchain
      network
      policy_id
      max_count
      nfts {
        ...NftsConnectionFragment
      }
      nft_project_mint {
        ...NFTProjectMintFragment
      }
      nft_project_royalty {
        ...NFTProjectRoyaltyFragment
      }
      nft_generator {
        ...NFTGeneratorFragment
      }
      wallet {
        ...WalletFragment
      }
      lock_after_datetime
      deleted_at
      nft_project_address
      created_at
      updated_at
    }
    error {
      message
      code
    }
  }
}
Variables
{"input": DeleteNFTProjectsInput}
Response
{
  "data": {
    "deleteNFTProjects": {
      "nftProjects": [NFTProject],
      "error": SaturnError
    }
  }
}

deleteNFTs

Response

Returns an DeleteNFTsPayload!

Arguments
Name Description
input - DeleteNFTsInput!

Example

Query
mutation deleteNFTs($input: DeleteNFTsInput!) {
  deleteNFTs(input: $input) {
    nftProject {
      id
      account_id
      name
      collection_id
      blockchain
      network
      policy_id
      max_count
      nfts {
        ...NftsConnectionFragment
      }
      nft_project_mint {
        ...NFTProjectMintFragment
      }
      nft_project_royalty {
        ...NFTProjectRoyaltyFragment
      }
      nft_generator {
        ...NFTGeneratorFragment
      }
      wallet {
        ...WalletFragment
      }
      lock_after_datetime
      deleted_at
      nft_project_address
      created_at
      updated_at
    }
    nfts {
      id
      nft_project_id
      nft_project {
        ...NFTProjectFragment
      }
      nft_mint {
        ...NFTMintFragment
      }
      nft_burn {
        ...NFTBurnFragment
      }
      collection_id
      policy_id
      asset_name
      name
      media_type
      image
      files {
        ...NFTFileFragment
      }
      json_properties
      individual_price {
        ...PriceFragment
      }
      created_at
      updated_at
    }
    error {
      message
      code
    }
  }
}
Variables
{"input": DeleteNFTsInput}
Response
{
  "data": {
    "deleteNFTs": {
      "nftProject": NFTProject,
      "nfts": [NFT],
      "error": SaturnError
    }
  }
}

deleteWhitelist

Response

Returns a DeleteWhitelistPayload

Arguments
Name Description
input - DeleteWhitelistInput!

Example

Query
mutation deleteWhitelist($input: DeleteWhitelistInput!) {
  deleteWhitelist(input: $input) {
    nftProject {
      id
      account_id
      name
      collection_id
      blockchain
      network
      policy_id
      max_count
      nfts {
        ...NftsConnectionFragment
      }
      nft_project_mint {
        ...NFTProjectMintFragment
      }
      nft_project_royalty {
        ...NFTProjectRoyaltyFragment
      }
      nft_generator {
        ...NFTGeneratorFragment
      }
      wallet {
        ...WalletFragment
      }
      lock_after_datetime
      deleted_at
      nft_project_address
      created_at
      updated_at
    }
    whitelists {
      id
      nft_project_mint_id
      nft_project_mint {
        ...NFTProjectMintFragment
      }
      whitelist_type
      name
      collection_id
      start_time
      end_time
      max_nfts_per_slot
      whitelist_prices {
        ...PriceFragment
      }
      required_policy_id
      required_owned_amount
      whitelist_slots {
        ...WhitelistSlotFragment
      }
      whitelist_started_time
      whitelist_ended_time
      created_at
      updated_at
    }
    error {
      message
      code
    }
  }
}
Variables
{"input": DeleteWhitelistInput}
Response
{
  "data": {
    "deleteWhitelist": {
      "nftProject": NFTProject,
      "whitelists": [Whitelist],
      "error": SaturnError
    }
  }
}

submitBuyDirectMintTransaction

Arguments
Name Description
input - SubmitBuyDirectMintTransactionInput!

Example

Query
mutation submitBuyDirectMintTransaction($input: SubmitBuyDirectMintTransactionInput!) {
  submitBuyDirectMintTransaction(input: $input) {
    transactionId
    error {
      message
      code
    }
  }
}
Variables
{"input": SubmitBuyDirectMintTransactionInput}
Response
{
  "data": {
    "submitBuyDirectMintTransaction": {
      "transactionId": "xyz789",
      "error": SaturnError
    }
  }
}

submitBuyRandomMintTransaction

Arguments
Name Description
input - SubmitBuyRandomMintTransactionInput!

Example

Query
mutation submitBuyRandomMintTransaction($input: SubmitBuyRandomMintTransactionInput!) {
  submitBuyRandomMintTransaction(input: $input) {
    transactionId
    error {
      message
      code
    }
  }
}
Variables
{"input": SubmitBuyRandomMintTransactionInput}
Response
{
  "data": {
    "submitBuyRandomMintTransaction": {
      "transactionId": "xyz789",
      "error": SaturnError
    }
  }
}

submitRoyaltyMintTransaction

Arguments
Name Description
input - SubmitRoyaltyMintTransactionInput!

Example

Query
mutation submitRoyaltyMintTransaction($input: SubmitRoyaltyMintTransactionInput!) {
  submitRoyaltyMintTransaction(input: $input) {
    transactionId
    error {
      message
      code
    }
  }
}
Variables
{"input": SubmitRoyaltyMintTransactionInput}
Response
{
  "data": {
    "submitRoyaltyMintTransaction": {
      "transactionId": "xyz789",
      "error": SaturnError
    }
  }
}

submitSingleOrBulkBurnTransaction

Arguments
Name Description
input - SubmitSingleOrBulkBurnTransactionInput!

Example

Query
mutation submitSingleOrBulkBurnTransaction($input: SubmitSingleOrBulkBurnTransactionInput!) {
  submitSingleOrBulkBurnTransaction(input: $input) {
    transactionId
    error {
      message
      code
    }
  }
}
Variables
{"input": SubmitSingleOrBulkBurnTransactionInput}
Response
{
  "data": {
    "submitSingleOrBulkBurnTransaction": {
      "transactionId": "xyz789",
      "error": SaturnError
    }
  }
}

submitSingleOrBulkMintTransaction

Arguments
Name Description
input - SubmitSingleOrBulkMintTransactionInput!

Example

Query
mutation submitSingleOrBulkMintTransaction($input: SubmitSingleOrBulkMintTransactionInput!) {
  submitSingleOrBulkMintTransaction(input: $input) {
    transactionId
    error {
      message
      code
    }
  }
}
Variables
{"input": SubmitSingleOrBulkMintTransactionInput}
Response
{
  "data": {
    "submitSingleOrBulkMintTransaction": {
      "transactionId": "abc123",
      "error": SaturnError
    }
  }
}

updateNFT

Response

Returns an UpdateNFTPayload!

Arguments
Name Description
input - UpdateNFTInput!

Example

Query
mutation updateNFT($input: UpdateNFTInput!) {
  updateNFT(input: $input) {
    nft {
      id
      nft_project_id
      nft_project {
        ...NFTProjectFragment
      }
      nft_mint {
        ...NFTMintFragment
      }
      nft_burn {
        ...NFTBurnFragment
      }
      collection_id
      policy_id
      asset_name
      name
      media_type
      image
      files {
        ...NFTFileFragment
      }
      json_properties
      individual_price {
        ...PriceFragment
      }
      created_at
      updated_at
    }
    error {
      message
      code
    }
  }
}
Variables
{"input": UpdateNFTInput}
Response
{
  "data": {
    "updateNFT": {
      "nft": NFT,
      "error": SaturnError
    }
  }
}

updateNFTGenerator

Response

Returns an UpdateNFTGeneratorPayload!

Arguments
Name Description
input - UpdateNFTGeneratorInput!

Example

Query
mutation updateNFTGenerator($input: UpdateNFTGeneratorInput!) {
  updateNFTGenerator(input: $input) {
    nftGenerator {
      id
      nft_project_id
      nft_project {
        ...NFTProjectFragment
      }
      nft_layers {
        ...NFTLayerFragment
      }
      created_at
      updated_at
    }
    error {
      message
      code
    }
  }
}
Variables
{"input": UpdateNFTGeneratorInput}
Response
{
  "data": {
    "updateNFTGenerator": {
      "nftGenerator": NFTGenerator,
      "error": SaturnError
    }
  }
}

updateNFTProject

Response

Returns an UpdateNFTProjectPayload!

Arguments
Name Description
input - UpdateNFTProjectInput!

Example

Query
mutation updateNFTProject($input: UpdateNFTProjectInput!) {
  updateNFTProject(input: $input) {
    nftProject {
      id
      account_id
      name
      collection_id
      blockchain
      network
      policy_id
      max_count
      nfts {
        ...NftsConnectionFragment
      }
      nft_project_mint {
        ...NFTProjectMintFragment
      }
      nft_project_royalty {
        ...NFTProjectRoyaltyFragment
      }
      nft_generator {
        ...NFTGeneratorFragment
      }
      wallet {
        ...WalletFragment
      }
      lock_after_datetime
      deleted_at
      nft_project_address
      created_at
      updated_at
    }
    error {
      message
      code
    }
  }
}
Variables
{"input": UpdateNFTProjectInput}
Response
{
  "data": {
    "updateNFTProject": {
      "nftProject": NFTProject,
      "error": SaturnError
    }
  }
}

updateWhitelist

Response

Returns an UpdateWhitelistPayload!

Arguments
Name Description
input - UpdateWhitelistInput!

Example

Query
mutation updateWhitelist($input: UpdateWhitelistInput!) {
  updateWhitelist(input: $input) {
    whitelists {
      id
      nft_project_mint_id
      nft_project_mint {
        ...NFTProjectMintFragment
      }
      whitelist_type
      name
      collection_id
      start_time
      end_time
      max_nfts_per_slot
      whitelist_prices {
        ...PriceFragment
      }
      required_policy_id
      required_owned_amount
      whitelist_slots {
        ...WhitelistSlotFragment
      }
      whitelist_started_time
      whitelist_ended_time
      created_at
      updated_at
    }
    error {
      message
      code
    }
  }
}
Variables
{"input": UpdateWhitelistInput}
Response
{
  "data": {
    "updateWhitelist": {
      "whitelists": [Whitelist],
      "error": SaturnError
    }
  }
}

uploadNFTImages

Response

Returns an UploadNFTImagesPayload!

Arguments
Name Description
input - UploadNFTImagesInput!

Example

Query
mutation uploadNFTImages($input: UploadNFTImagesInput!) {
  uploadNFTImages(input: $input) {
    nftProject {
      id
      account_id
      name
      collection_id
      blockchain
      network
      policy_id
      max_count
      nfts {
        ...NftsConnectionFragment
      }
      nft_project_mint {
        ...NFTProjectMintFragment
      }
      nft_project_royalty {
        ...NFTProjectRoyaltyFragment
      }
      nft_generator {
        ...NFTGeneratorFragment
      }
      wallet {
        ...WalletFragment
      }
      lock_after_datetime
      deleted_at
      nft_project_address
      created_at
      updated_at
    }
    link
    error {
      message
      code
    }
  }
}
Variables
{"input": UploadNFTImagesInput}
Response
{
  "data": {
    "uploadNFTImages": {
      "nftProject": NFTProject,
      "link": "xyz789",
      "error": SaturnError
    }
  }
}

uploadNFTMetadatas

Response

Returns an UploadNFTMetadataPayload

Arguments
Name Description
input - UploadNFTMetadataInput!

Example

Query
mutation uploadNFTMetadatas($input: UploadNFTMetadataInput!) {
  uploadNFTMetadatas(input: $input) {
    nftProject {
      id
      account_id
      name
      collection_id
      blockchain
      network
      policy_id
      max_count
      nfts {
        ...NftsConnectionFragment
      }
      nft_project_mint {
        ...NFTProjectMintFragment
      }
      nft_project_royalty {
        ...NFTProjectRoyaltyFragment
      }
      nft_generator {
        ...NFTGeneratorFragment
      }
      wallet {
        ...WalletFragment
      }
      lock_after_datetime
      deleted_at
      nft_project_address
      created_at
      updated_at
    }
    link
    error {
      message
      code
    }
  }
}
Variables
{"input": UploadNFTMetadataInput}
Response
{
  "data": {
    "uploadNFTMetadatas": {
      "nftProject": NFTProject,
      "link": "abc123",
      "error": SaturnError
    }
  }
}

Types

AddNFTMetdataInput

Fields
Input Field Description
index - Long!
metadata - Upload!
Example
{"index": 456, "metadata": Upload}

AddNFTProjectsPayload

Fields
Field Name Description
nftProject - NFTProject
error - SaturnError
Example
{
  "nftProject": NFTProject,
  "error": SaturnError
}

AddNFTsInput

Fields
Input Field Description
nftProjectId - String!
count - Int!
Example
{"nftProjectId": "xyz789", "count": 987}

AddNFTsPayload

Fields
Field Name Description
nfts - [NFT!]
error - SaturnError
Example
{
  "nfts": [NFT],
  "error": SaturnError
}

AddWhitelistInput

Fields
Input Field Description
nftProjectId - String!
count - Int!
Example
{"nftProjectId": "abc123", "count": 123}

AddWhitelistPayload

Fields
Field Name Description
whitelists - [Whitelist!]
error - SaturnError
Example
{
  "whitelists": [Whitelist],
  "error": SaturnError
}

Any

Example
Any

ApplyPolicy

Values
Enum Value Description

BEFORE_RESOLVER

AFTER_RESOLVER

Example
"BEFORE_RESOLVER"

Blockchain

Values
Enum Value Description

NONE

CARDANO

ETHEREUM

SOLANA

Example
"NONE"

Boolean

Description

The Boolean scalar type represents true or false.

Example
true

BurnStatus

Values
Enum Value Description

NONE

CREATING_TRANSACTION

AWAITING_SIGNATURE

SUBMITTING_TRANSACTION

PENDING

COMPLETE

CANCELLED

FAILED

Example
"NONE"

BurnType

Values
Enum Value Description

NONE

SINGLE

BULK

Example
"NONE"

CancelBuyDirectMintTransactionInput

Fields
Input Field Description
nftProjectId - String!
paymentAddress - String!
error - String
Example
{
  "nftProjectId": "xyz789",
  "paymentAddress": "xyz789",
  "error": "xyz789"
}

CancelBuyDirectMintTransactionPayload

Fields
Field Name Description
nftProjectId - String
error - SaturnError
Example
{
  "nftProjectId": "abc123",
  "error": SaturnError
}

CancelBuyRandomMintTransactionInput

Fields
Input Field Description
nftProjectId - String!
paymentAddress - String!
error - String
Example
{
  "nftProjectId": "xyz789",
  "paymentAddress": "xyz789",
  "error": "abc123"
}

CancelBuyRandomMintTransactionPayload

Fields
Field Name Description
nftProjectId - String
error - SaturnError
Example
{
  "nftProjectId": "abc123",
  "error": SaturnError
}

CancelSingleOrBulkBurnTransactionInput

Fields
Input Field Description
nftProjectId - String!
nftIds - [String!]!
paymentAddress - String!
Example
{
  "nftProjectId": "abc123",
  "nftIds": ["abc123"],
  "paymentAddress": "abc123"
}

CancelSingleOrBulkBurnTransactionPayload

Fields
Field Name Description
nftProjectId - String
error - SaturnError
Example
{
  "nftProjectId": "abc123",
  "error": SaturnError
}

CancelSingleOrBulkMintTransactionInput

Fields
Input Field Description
nftProjectId - String!
nftIds - [String!]!
paymentAddress - String!
Example
{
  "nftProjectId": "abc123",
  "nftIds": ["xyz789"],
  "paymentAddress": "xyz789"
}

CancelSingleOrBulkMintTransactionPayload

Fields
Field Name Description
nftProjectId - String
error - SaturnError
Example
{
  "nftProjectId": "abc123",
  "error": SaturnError
}

CreateBuyDirectMintTransactionInput

Fields
Input Field Description
nftProjectId - String!
paymentAddress - String!
nftIds - [String!]!
paymentToken - String
gReCaptchaToken - String
Example
{
  "nftProjectId": "abc123",
  "paymentAddress": "xyz789",
  "nftIds": ["abc123"],
  "paymentToken": "xyz789",
  "gReCaptchaToken": "xyz789"
}

CreateBuyDirectMintTransactionPayload

Fields
Field Name Description
hexTransaction - String
error - SaturnError
Example
{
  "hexTransaction": "xyz789",
  "error": SaturnError
}

CreateBuyRandomMintTransactionInput

Fields
Input Field Description
nftProjectId - String!
paymentAddress - String!
count - Int!
paymentToken - String
gReCaptchaToken - String
Example
{
  "nftProjectId": "xyz789",
  "paymentAddress": "xyz789",
  "count": 123,
  "paymentToken": "abc123",
  "gReCaptchaToken": "abc123"
}

CreateBuyRandomMintTransactionPayload

Fields
Field Name Description
hexTransaction - String
error - SaturnError
Example
{
  "hexTransaction": "xyz789",
  "error": SaturnError
}

CreateRoyaltyMintTransactionInput

Fields
Input Field Description
nftProjectId - String!
Example
{"nftProjectId": "abc123"}

CreateRoyaltyMintTransactionPayload

Fields
Field Name Description
hexTransaction - String
error - SaturnError
Example
{
  "hexTransaction": "xyz789",
  "error": SaturnError
}

CreateSingleOrBulkBurnTransactionInput

Fields
Input Field Description
nftProjectId - String!
nftIds - [String!]!
paymentAddress - String!
Example
{
  "nftProjectId": "abc123",
  "nftIds": ["abc123"],
  "paymentAddress": "abc123"
}

CreateSingleOrBulkBurnTransactionPayload

Fields
Field Name Description
hexTransaction - String
error - SaturnError
Example
{
  "hexTransaction": "abc123",
  "error": SaturnError
}

CreateSingleOrBulkMintTransactionInput

Fields
Input Field Description
nftProjectId - String!
nftIds - [String!]!
paymentAddress - String!
receiveAddress - String!
Example
{
  "nftProjectId": "abc123",
  "nftIds": ["abc123"],
  "paymentAddress": "xyz789",
  "receiveAddress": "abc123"
}

CreateSingleOrBulkMintTransactionPayload

Fields
Field Name Description
hexTransaction - String
error - SaturnError
Example
{
  "hexTransaction": "xyz789",
  "error": SaturnError
}

DateTime

Description

The DateTime scalar represents an ISO-8601 compliant date time type.

Example
"2007-12-03T10:15:30Z"

DeleteAllNFTsInput

Fields
Input Field Description
nftProjectId - String!
Example
{"nftProjectId": "abc123"}

DeleteAllNFTsPayload

Fields
Field Name Description
nftProject - NFTProject
error - SaturnError
Example
{
  "nftProject": NFTProject,
  "error": SaturnError
}

DeleteNFTInput

Fields
Input Field Description
nftId - String!
Example
{"nftId": "xyz789"}

DeleteNFTProjectInput

Fields
Input Field Description
nftProjectId - String!
Example
{"nftProjectId": "xyz789"}

DeleteNFTProjectsInput

Fields
Input Field Description
nftProjects - [DeleteNFTProjectInput!]!
Example
{"nftProjects": [DeleteNFTProjectInput]}

DeleteNFTProjectsPayload

Fields
Field Name Description
nftProjects - [NFTProject!]
error - SaturnError
Example
{
  "nftProjects": [NFTProject],
  "error": SaturnError
}

DeleteNFTsInput

Fields
Input Field Description
nftProjectId - String!
nfts - [DeleteNFTInput!]!
Example
{
  "nftProjectId": "abc123",
  "nfts": [DeleteNFTInput]
}

DeleteNFTsPayload

Fields
Field Name Description
nftProject - NFTProject
nfts - [NFT!]
error - SaturnError
Example
{
  "nftProject": NFTProject,
  "nfts": [NFT],
  "error": SaturnError
}

DeleteWhitelistInput

Fields
Input Field Description
nftProjectId - String!
whitelistId - String!
Example
{
  "nftProjectId": "xyz789",
  "whitelistId": "abc123"
}

DeleteWhitelistPayload

Fields
Field Name Description
nftProject - NFTProject
whitelists - [Whitelist!]
error - SaturnError
Example
{
  "nftProject": NFTProject,
  "whitelists": [Whitelist],
  "error": SaturnError
}

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
987.65

GetBuyRandomMintPaymentInput

Fields
Input Field Description
nftProjectId - String!
address - String
count - Int
Example
{
  "nftProjectId": "xyz789",
  "address": "xyz789",
  "count": 123
}

GetBuyRandomMintPaymentPayload

Fields
Field Name Description
id - UUID!
name - String
blockchain - Blockchain!
network - Network!
policyId - String
reservedNFTs - Long
completedNFTs - Long
totalNFTs - Long
prices - [NFTPaymentPrice!]!
maxPerTx - Long
maxPerWallet - Long
mintStart - DateTime
mintEnd - DateTime
lockAfterDatetime - DateTime
isActive - Boolean!
isFreeMint - Boolean!
error - SaturnError
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "name": "abc123",
  "blockchain": "NONE",
  "network": "PREPROD",
  "policyId": "abc123",
  "reservedNFTs": 456,
  "completedNFTs": 456,
  "totalNFTs": 456,
  "prices": [NFTPaymentPrice],
  "maxPerTx": 456,
  "maxPerWallet": 456,
  "mintStart": "2007-12-03T10:15:30Z",
  "mintEnd": "2007-12-03T10:15:30Z",
  "lockAfterDatetime": "2007-12-03T10:15:30Z",
  "isActive": false,
  "isFreeMint": true,
  "error": SaturnError
}

GetBuyRandomMintPurchasesInput

Fields
Input Field Description
nftProjectId - String
address - String
txHash - String
Example
{
  "nftProjectId": "xyz789",
  "address": "abc123",
  "txHash": "abc123"
}

GetBuyRandomMintPurchasesPayload

Fields
Field Name Description
nftProjectId - String
address - String
purchasedNFTs - [PurchaseNFT!]
error - SaturnError
Example
{
  "nftProjectId": "abc123",
  "address": "abc123",
  "purchasedNFTs": [PurchaseNFT],
  "error": SaturnError
}

GetNFTGeneratorPayload

Fields
Field Name Description
nftGenerator - NFTGenerator
error - SaturnError
Example
{
  "nftGenerator": NFTGenerator,
  "error": SaturnError
}

GetNFTPayload

Fields
Field Name Description
nft - NFT
error - SaturnError
Example
{"nft": NFT, "error": SaturnError}

GetNFTsInput

Fields
Input Field Description
nftProjectId - String!
Example
{"nftProjectId": "abc123"}

GetWhitelistInput

Fields
Input Field Description
nftProjectId - String!
Example
{"nftProjectId": "xyz789"}

GetWhitelistPayload

Fields
Field Name Description
whitelists - [Whitelist!]
error - SaturnError
Example
{
  "whitelists": [Whitelist],
  "error": SaturnError
}

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987

KeyType

Values
Enum Value Description

EXTERNAL

INTERNAL

STAKING

ACCOUNT

Example
"EXTERNAL"

Long

Description

The Long scalar type represents non-fractional signed whole 64-bit numeric values. Long can represent values between -(2^63) and 2^63 - 1.

Example
456

MintStatus

Values
Enum Value Description

NONE

CREATING_TRANSACTION

AWAITING_SIGNATURE

SUBMITTING_TRANSACTION

PENDING

COMPLETE

CANCELLED

FAILED

Example
"NONE"

MintType

Values
Enum Value Description

NONE

SINGLE

BULK

BUY

BUY_DIRECT

BUY_RANDOM

AUCTION

DUTCH_AUCTION

Example
"NONE"

NFT

Fields
Field Name Description
id - UUID!
nft_project_id - UUID!
nft_project - NFTProject!
nft_mint - NFTMint!
nft_burn - NFTBurn!
collection_id - Long!
policy_id - String
asset_name - String
name - String
media_type - String
image - String
files - [NFTFile!]!
json_properties - String
individual_price - Price
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project": NFTProject,
  "nft_mint": NFTMint,
  "nft_burn": NFTBurn,
  "collection_id": 456,
  "policy_id": "abc123",
  "asset_name": "abc123",
  "name": "abc123",
  "media_type": "xyz789",
  "image": "xyz789",
  "files": [NFTFile],
  "json_properties": "xyz789",
  "individual_price": Price,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTBurn

Fields
Field Name Description
id - UUID!
nft_project_id - UUID!
nft_project - NFTProject!
nft_id - UUID!
nft - NFT!
burn_address - String
burn_tx_hash - String
burn_tx - String
tx_size - Long
tx_nft_count - Long
burn_type - BurnType
burn_status - BurnStatus
status_timestamp - DateTime
burn_timestamp - DateTime
total_price - Float
price_per_nft - Float
tx_fee - Float
platform_fee - Float
tx_fee_per_nft - Float
platform_fee_per_nft - Float
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project": NFTProject,
  "nft_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft": NFT,
  "burn_address": "xyz789",
  "burn_tx_hash": "xyz789",
  "burn_tx": "xyz789",
  "tx_size": 456,
  "tx_nft_count": 456,
  "burn_type": "NONE",
  "burn_status": "NONE",
  "status_timestamp": "2007-12-03T10:15:30Z",
  "burn_timestamp": "2007-12-03T10:15:30Z",
  "total_price": 987.65,
  "price_per_nft": 123.45,
  "tx_fee": 123.45,
  "platform_fee": 987.65,
  "tx_fee_per_nft": 123.45,
  "platform_fee_per_nft": 123.45,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTBurnInput

Fields
Input Field Description
id - UUID!
nft_project_id - UUID!
nft_project - NFTProjectInput!
nft_id - UUID!
nft - NFTInput!
burn_address - String
burn_tx_hash - String
burn_tx - String
tx_size - Long
tx_nft_count - Long
burn_type - BurnType
burn_status - BurnStatus
status_timestamp - DateTime
burn_timestamp - DateTime
total_price - Float
price_per_nft - Float
tx_fee - Float
platform_fee - Float
tx_fee_per_nft - Float
platform_fee_per_nft - Float
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project": NFTProjectInput,
  "nft_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft": NFTInput,
  "burn_address": "xyz789",
  "burn_tx_hash": "abc123",
  "burn_tx": "xyz789",
  "tx_size": 456,
  "tx_nft_count": 456,
  "burn_type": "NONE",
  "burn_status": "NONE",
  "status_timestamp": "2007-12-03T10:15:30Z",
  "burn_timestamp": "2007-12-03T10:15:30Z",
  "total_price": 987.65,
  "price_per_nft": 123.45,
  "tx_fee": 987.65,
  "platform_fee": 123.45,
  "tx_fee_per_nft": 987.65,
  "platform_fee_per_nft": 123.45,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTFile

Fields
Field Name Description
id - UUID!
nft_id - UUID!
nft - NFT!
file_id - Long!
name - String
media_type - String
src - String
properties - Any
json_properties - String
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft": NFT,
  "file_id": 456,
  "name": "xyz789",
  "media_type": "xyz789",
  "src": "abc123",
  "properties": Any,
  "json_properties": "xyz789",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTFileDataInput

Fields
Input Field Description
id - String
name - String
mediaType - String
src - String
jsonProperties - String
fileId - Long
Example
{
  "id": "abc123",
  "name": "xyz789",
  "mediaType": "xyz789",
  "src": "xyz789",
  "jsonProperties": "xyz789",
  "fileId": 456
}

NFTFileInput

Fields
Input Field Description
id - UUID!
nft_id - UUID!
nft - NFTInput!
file_id - Long!
name - String
media_type - String
src - String
properties - Any
json_properties - String
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft": NFTInput,
  "file_id": 456,
  "name": "abc123",
  "media_type": "abc123",
  "src": "abc123",
  "properties": Any,
  "json_properties": "abc123",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTGenerator

Fields
Field Name Description
id - UUID!
nft_project_id - UUID!
nft_project - NFTProject!
nft_layers - [NFTLayer!]!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project": NFTProject,
  "nft_layers": [NFTLayer],
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTInput

Fields
Input Field Description
id - UUID!
nft_project_id - UUID!
nft_project - NFTProjectInput!
nft_mint - NFTMintInput!
nft_burn - NFTBurnInput!
collection_id - Long!
policy_id - String
asset_name - String
name - String
media_type - String
image - String
files - [NFTFileInput!]!
properties - Any
json_properties - String
individual_price - PriceInput
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project": NFTProjectInput,
  "nft_mint": NFTMintInput,
  "nft_burn": NFTBurnInput,
  "collection_id": 456,
  "policy_id": "abc123",
  "asset_name": "xyz789",
  "name": "abc123",
  "media_type": "abc123",
  "image": "abc123",
  "files": [NFTFileInput],
  "properties": Any,
  "json_properties": "abc123",
  "individual_price": PriceInput,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTLayer

Fields
Field Name Description
id - UUID!
nft_generator_id - UUID!
nft_generator - NFTGenerator!
nft_traits - [NFTTrait!]!
index - Long!
name - String
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_generator_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_generator": NFTGenerator,
  "nft_traits": [NFTTrait],
  "index": 456,
  "name": "abc123",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTMint

Fields
Field Name Description
id - UUID!
nft_project_id - UUID!
nft_project - NFTProject!
nft_id - UUID!
nft - NFT!
mint_address - String
mint_tx_hash - String
mint_tx - String
tx_size - Long
tx_nft_count - Long
mint_type - MintType!
mint_status - MintStatus
status_timestamp - DateTime
mint_timestamp - DateTime
total_price - Float
price_per_nft - Float
tx_fee - Float
platform_fee - Float
tx_fee_per_nft - Float
platform_fee_per_nft - Float
token - String
total_token_price - Float
token_price_per_nft - Float
whitelist_slot_mints - [WhitelistSlotMint!]
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project": NFTProject,
  "nft_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft": NFT,
  "mint_address": "abc123",
  "mint_tx_hash": "abc123",
  "mint_tx": "abc123",
  "tx_size": 456,
  "tx_nft_count": 456,
  "mint_type": "NONE",
  "mint_status": "NONE",
  "status_timestamp": "2007-12-03T10:15:30Z",
  "mint_timestamp": "2007-12-03T10:15:30Z",
  "total_price": 123.45,
  "price_per_nft": 123.45,
  "tx_fee": 987.65,
  "platform_fee": 987.65,
  "tx_fee_per_nft": 123.45,
  "platform_fee_per_nft": 123.45,
  "token": "abc123",
  "total_token_price": 987.65,
  "token_price_per_nft": 123.45,
  "whitelist_slot_mints": [WhitelistSlotMint],
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTMintInput

Fields
Input Field Description
id - UUID!
nft_project_id - UUID!
nft_project - NFTProjectInput!
nft_id - UUID!
nft - NFTInput!
mint_address - String
mint_tx_hash - String
mint_tx - String
tx_size - Long
tx_nft_count - Long
mint_type - MintType!
mint_status - MintStatus
status_timestamp - DateTime
mint_timestamp - DateTime
total_price - Float
price_per_nft - Float
tx_fee - Float
platform_fee - Float
tx_fee_per_nft - Float
platform_fee_per_nft - Float
token - String
total_token_price - Float
token_price_per_nft - Float
whitelist_slot_mints - [WhitelistSlotMintInput!]
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project": NFTProjectInput,
  "nft_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft": NFTInput,
  "mint_address": "abc123",
  "mint_tx_hash": "xyz789",
  "mint_tx": "xyz789",
  "tx_size": 456,
  "tx_nft_count": 456,
  "mint_type": "NONE",
  "mint_status": "NONE",
  "status_timestamp": "2007-12-03T10:15:30Z",
  "mint_timestamp": "2007-12-03T10:15:30Z",
  "total_price": 123.45,
  "price_per_nft": 987.65,
  "tx_fee": 123.45,
  "platform_fee": 123.45,
  "tx_fee_per_nft": 123.45,
  "platform_fee_per_nft": 987.65,
  "token": "abc123",
  "total_token_price": 123.45,
  "token_price_per_nft": 987.65,
  "whitelist_slot_mints": [WhitelistSlotMintInput],
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTPaymentPrice

Fields
Field Name Description
adaPrice - Float
allowAdaPayment - Boolean
tokenPrices - [NFTPaymentTokenPrice!]!
isMainPrice - Boolean
Example
{
  "adaPrice": 123.45,
  "allowAdaPayment": false,
  "tokenPrices": [NFTPaymentTokenPrice],
  "isMainPrice": false
}

NFTPaymentTokenPrice

Fields
Field Name Description
tokenPrice - Float
tokenFullName - String
tokenName - String
tokenImage - String
allowTokenPayment - Boolean
Example
{
  "tokenPrice": 987.65,
  "tokenFullName": "xyz789",
  "tokenName": "xyz789",
  "tokenImage": "xyz789",
  "allowTokenPayment": true
}

NFTPriceDataInput

Fields
Input Field Description
adaPrice - Float
allowAdaPayment - Boolean
isMainPrice - Boolean
tokenPrices - [NFTTokenPriceDataInput!]
Example
{
  "adaPrice": 987.65,
  "allowAdaPayment": false,
  "isMainPrice": false,
  "tokenPrices": [NFTTokenPriceDataInput]
}

NFTProject

Fields
Field Name Description
id - UUID!
account_id - UUID!
name - String
collection_id - Long!
blockchain - Blockchain!
network - Network!
policy_id - String
max_count - Long!
nfts - NftsConnection
Arguments
first - Int

Returns the first n elements from the list.

after - String

Returns the elements in the list that come after the specified cursor.

last - Int

Returns the last n elements from the list.

before - String

Returns the elements in the list that come before the specified cursor.

nft_project_mint - NFTProjectMint!
nft_project_royalty - NFTProjectRoyalty!
nft_generator - NFTGenerator
wallet - Wallet!
lock_after_datetime - DateTime
deleted_at - DateTime
nft_project_address - String
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "account_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "name": "xyz789",
  "collection_id": 456,
  "blockchain": "NONE",
  "network": "PREPROD",
  "policy_id": "abc123",
  "max_count": 456,
  "nfts": NftsConnection,
  "nft_project_mint": NFTProjectMint,
  "nft_project_royalty": NFTProjectRoyalty,
  "nft_generator": NFTGenerator,
  "wallet": Wallet,
  "lock_after_datetime": "2007-12-03T10:15:30Z",
  "deleted_at": "2007-12-03T10:15:30Z",
  "nft_project_address": "xyz789",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTProjectInput

Fields
Input Field Description
id - UUID!
account_id - UUID!
name - String
collection_id - Long!
blockchain - Blockchain!
network - Network!
policy_id - String
max_count - Long!
nfts - [NFTInput!]!
nft_project_mint - NFTProjectMintInput!
nft_project_royalty - NFTProjectRoyaltyInput!
wallet - WalletInput!
lock_after_datetime - DateTime
deleted_at - DateTime
nft_project_address - String
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "account_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "name": "xyz789",
  "collection_id": 456,
  "blockchain": "NONE",
  "network": "PREPROD",
  "policy_id": "abc123",
  "max_count": 456,
  "nfts": [NFTInput],
  "nft_project_mint": NFTProjectMintInput,
  "nft_project_royalty": NFTProjectRoyaltyInput,
  "wallet": WalletInput,
  "lock_after_datetime": "2007-12-03T10:15:30Z",
  "deleted_at": "2007-12-03T10:15:30Z",
  "nft_project_address": "xyz789",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTProjectMint

Fields
Field Name Description
id - UUID!
nft_project_id - UUID!
nft_project - NFTProject!
mint_type - MintType!
mint_start - DateTime
mint_end - DateTime
platform_fee_percent - Float!
min_platform_fee - Float!
partner_fee_percent - Float!
min_partner_fee - Float!
is_free_mint - Boolean!
prices - [Price!]!
max_per_transaction - Int!
max_per_wallet - Int!
has_blob_at_mint_start - Boolean!
max_whitelists - Int!
whitelists - [Whitelist!]!
has_public_mint - Boolean!
public_start_time - Long!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project": NFTProject,
  "mint_type": "NONE",
  "mint_start": "2007-12-03T10:15:30Z",
  "mint_end": "2007-12-03T10:15:30Z",
  "platform_fee_percent": 123.45,
  "min_platform_fee": 987.65,
  "partner_fee_percent": 987.65,
  "min_partner_fee": 987.65,
  "is_free_mint": false,
  "prices": [Price],
  "max_per_transaction": 123,
  "max_per_wallet": 123,
  "has_blob_at_mint_start": false,
  "max_whitelists": 123,
  "whitelists": [Whitelist],
  "has_public_mint": false,
  "public_start_time": 456,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTProjectMintInput

Fields
Input Field Description
id - UUID!
nft_project_id - UUID!
nft_project - NFTProjectInput!
mint_type - MintType!
mint_start - DateTime
mint_end - DateTime
platform_fee_percent - Float!
min_platform_fee - Float!
partner_fee_percent - Float!
min_partner_fee - Float!
is_free_mint - Boolean!
prices - [PriceInput!]!
max_per_transaction - Int!
max_per_wallet - Int!
has_blob_at_mint_start - Boolean!
max_whitelists - Int!
whitelists - [WhitelistInput!]!
has_public_mint - Boolean!
public_start_time - Long!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project": NFTProjectInput,
  "mint_type": "NONE",
  "mint_start": "2007-12-03T10:15:30Z",
  "mint_end": "2007-12-03T10:15:30Z",
  "platform_fee_percent": 987.65,
  "min_platform_fee": 987.65,
  "partner_fee_percent": 987.65,
  "min_partner_fee": 123.45,
  "is_free_mint": true,
  "prices": [PriceInput],
  "max_per_transaction": 987,
  "max_per_wallet": 123,
  "has_blob_at_mint_start": true,
  "max_whitelists": 123,
  "whitelists": [WhitelistInput],
  "has_public_mint": false,
  "public_start_time": 456,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTProjectRoyalty

Fields
Field Name Description
id - UUID!
nft_project_id - UUID!
nft_project - NFTProject!
royalty_address - String
royalty_percent - Float!
mint_address - String
mint_tx_hash - String
mint_tx - String
mint_tx_fee - Float
mint_tx_size - Long
mint_datetime - DateTime
return_address - String
burn_tx_hash - String
burn_tx - String
burn_tx_fee - Float
burn_tx_size - Long
burn_datetime - DateTime
mint_status - RoyaltyMintStatus
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project": NFTProject,
  "royalty_address": "abc123",
  "royalty_percent": 987.65,
  "mint_address": "xyz789",
  "mint_tx_hash": "abc123",
  "mint_tx": "xyz789",
  "mint_tx_fee": 987.65,
  "mint_tx_size": 456,
  "mint_datetime": "2007-12-03T10:15:30Z",
  "return_address": "xyz789",
  "burn_tx_hash": "xyz789",
  "burn_tx": "abc123",
  "burn_tx_fee": 987.65,
  "burn_tx_size": 456,
  "burn_datetime": "2007-12-03T10:15:30Z",
  "mint_status": "NONE",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTProjectRoyaltyInput

Fields
Input Field Description
id - UUID!
nft_project_id - UUID!
nft_project - NFTProjectInput!
royalty_address - String
royalty_percent - Float!
mint_address - String
mint_tx_hash - String
mint_tx - String
mint_tx_fee - Float
mint_tx_size - Long
mint_datetime - DateTime
return_address - String
burn_tx_hash - String
burn_tx - String
burn_tx_fee - Float
burn_tx_size - Long
burn_datetime - DateTime
mint_status - RoyaltyMintStatus
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project": NFTProjectInput,
  "royalty_address": "abc123",
  "royalty_percent": 987.65,
  "mint_address": "abc123",
  "mint_tx_hash": "abc123",
  "mint_tx": "xyz789",
  "mint_tx_fee": 123.45,
  "mint_tx_size": 456,
  "mint_datetime": "2007-12-03T10:15:30Z",
  "return_address": "xyz789",
  "burn_tx_hash": "abc123",
  "burn_tx": "xyz789",
  "burn_tx_fee": 987.65,
  "burn_tx_size": 456,
  "burn_datetime": "2007-12-03T10:15:30Z",
  "mint_status": "NONE",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTProjectsConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [NFTProjectsEdge!] A list of edges.
nodes - [NFTProject!] A flattened list of the nodes.
totalCount - Int!
Example
{
  "pageInfo": PageInfo,
  "edges": [NFTProjectsEdge],
  "nodes": [NFTProject],
  "totalCount": 123
}

NFTProjectsEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - NFTProject! The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": NFTProject
}

NFTTokenPriceDataInput

Fields
Input Field Description
tokenFullName - String
tokenPrice - Float
allowTokenPayment - Boolean
Example
{
  "tokenFullName": "abc123",
  "tokenPrice": 987.65,
  "allowTokenPayment": true
}

NFTTrait

Fields
Field Name Description
id - UUID!
nft_layer_id - UUID!
nft_layer - NFTLayer!
nft_variations - [NFTVariation!]!
layer_index - Long!
index - Long!
name - String
percent - Float!
image - String
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_layer_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_layer": NFTLayer,
  "nft_variations": [NFTVariation],
  "layer_index": 456,
  "index": 456,
  "name": "abc123",
  "percent": 987.65,
  "image": "abc123",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTVariation

Fields
Field Name Description
id - UUID!
nft_trait_id - UUID!
nft_trait - NFTTrait!
layer_index - Long!
trait_index - Long!
index - Long!
name - String
percent - Float!
image - String
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_trait_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_trait": NFTTrait,
  "layer_index": 456,
  "trait_index": 456,
  "index": 456,
  "name": "xyz789",
  "percent": 123.45,
  "image": "abc123",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

NFTsConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [NFTsEdge!] A list of edges.
nodes - [NFT!] A flattened list of the nodes.
totalCount - Int!
Example
{
  "pageInfo": PageInfo,
  "edges": [NFTsEdge],
  "nodes": [NFT],
  "totalCount": 987
}

NFTsEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - NFT! The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": NFT
}

Network

Values
Enum Value Description

PREPROD

MAINNET

Example
"PREPROD"

NftsConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [NftsEdge!] A list of edges.
nodes - [NFT!] A flattened list of the nodes.
totalCount - Int!
Example
{
  "pageInfo": PageInfo,
  "edges": [NftsEdge],
  "nodes": [NFT],
  "totalCount": 123
}

NftsEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - NFT! The item at the end of the edge.
Example
{
  "cursor": "xyz789",
  "node": NFT
}

PageInfo

Description

Information about pagination in a connection.

Fields
Field Name Description
hasNextPage - Boolean! Indicates whether more edges exist following the set defined by the clients arguments.
hasPreviousPage - Boolean! Indicates whether more edges exist prior the set defined by the clients arguments.
startCursor - String When paginating backwards, the cursor to continue.
endCursor - String When paginating forwards, the cursor to continue.
Example
{
  "hasNextPage": true,
  "hasPreviousPage": false,
  "startCursor": "xyz789",
  "endCursor": "xyz789"
}

Payment

Fields
Field Name Description
id - UUID!
payment_project_id - UUID!
payment_project - PaymentProject!
collection_id - Long!
payment_price - PaymentPrice!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "payment_project_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "payment_project": PaymentProject,
  "collection_id": 456,
  "payment_price": PaymentPrice,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

PaymentPrice

Fields
Field Name Description
id - UUID!
payment_id - UUID!
payment - Payment!
payment_price_tokens - [PaymentPriceToken!]!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "payment_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "payment": Payment,
  "payment_price_tokens": [PaymentPriceToken],
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

PaymentPriceToken

Fields
Field Name Description
id - UUID!
payment_price_id - UUID!
payment_price - PaymentPrice!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "payment_price_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "payment_price": PaymentPrice,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

PaymentProject

Fields
Field Name Description
update - SaturnError
id - UUID!
account_id - UUID!
payments - PaymentsConnection
Arguments
first - Int

Returns the first n elements from the list.

after - String

Returns the elements in the list that come after the specified cursor.

last - Int

Returns the last n elements from the list.

before - String

Returns the elements in the list that come before the specified cursor.

deleted_at - DateTime
created_at - DateTime
updated_at - DateTime
Example
{
  "update": SaturnError,
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "account_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "payments": PaymentsConnection,
  "deleted_at": "2007-12-03T10:15:30Z",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

PaymentSortInput

Fields
Input Field Description
id - SortEnumType
payment_project_id - SortEnumType
collection_id - SortEnumType
created_at - SortEnumType
updated_at - SortEnumType
Example
{
  "id": "ASC",
  "payment_project_id": "ASC",
  "collection_id": "ASC",
  "created_at": "ASC",
  "updated_at": "ASC"
}

PaymentsConnection

Description

A connection to a list of items.

Fields
Field Name Description
pageInfo - PageInfo! Information to aid in pagination.
edges - [PaymentsEdge!] A list of edges.
nodes - [Payment!] A flattened list of the nodes.
totalCount - Int!
Example
{
  "pageInfo": PageInfo,
  "edges": [PaymentsEdge],
  "nodes": [Payment],
  "totalCount": 987
}

PaymentsEdge

Description

An edge in a connection.

Fields
Field Name Description
cursor - String! A cursor for use in pagination.
node - Payment! The item at the end of the edge.
Example
{
  "cursor": "abc123",
  "node": Payment
}

Price

Fields
Field Name Description
id - UUID!
nft_project_mint_id - UUID
nft_project_mint - NFTProjectMint
nft_id - UUID
nft - NFT
whitelist_id - UUID
whitelist - Whitelist
ada_price - Float!
allow_ada_payment - Boolean!
token_prices - [TokenPrice!]!
is_main_price - Boolean!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_mint_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_mint": NFTProjectMint,
  "nft_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft": NFT,
  "whitelist_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "whitelist": Whitelist,
  "ada_price": 123.45,
  "allow_ada_payment": true,
  "token_prices": [TokenPrice],
  "is_main_price": false,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

PriceInput

Fields
Input Field Description
id - UUID!
nft_project_mint_id - UUID
nft_project_mint - NFTProjectMintInput
nft_id - UUID
nft - NFTInput
whitelist_id - UUID
whitelist - WhitelistInput
ada_price - Float!
allow_ada_payment - Boolean!
token_prices - [TokenPriceInput!]!
is_main_price - Boolean!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_mint_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_mint": NFTProjectMintInput,
  "nft_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft": NFTInput,
  "whitelist_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "whitelist": WhitelistInput,
  "ada_price": 123.45,
  "allow_ada_payment": true,
  "token_prices": [TokenPriceInput],
  "is_main_price": true,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

PurchaseNFT

Fields
Field Name Description
name - String
image - String
Example
{
  "name": "xyz789",
  "image": "abc123"
}

RoyaltyMintStatus

Values
Enum Value Description

NONE

AWAITING_SIGNATURE

PENDING_MINT

PENDING_BURN

COMPLETE

CANCELLED

FAILED

Example
"NONE"

SaturnError

Fields
Field Name Description
message - String
code - String
Example
{
  "message": "abc123",
  "code": "abc123"
}

SortEnumType

Values
Enum Value Description

ASC

DESC

Example
"ASC"

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"

SubmitBuyDirectMintTransactionInput

Fields
Input Field Description
nftProjectId - String!
paymentAddress - String!
hexTransaction - String!
Example
{
  "nftProjectId": "abc123",
  "paymentAddress": "abc123",
  "hexTransaction": "abc123"
}

SubmitBuyDirectMintTransactionPayload

Fields
Field Name Description
transactionId - String
error - SaturnError
Example
{
  "transactionId": "xyz789",
  "error": SaturnError
}

SubmitBuyRandomMintTransactionInput

Fields
Input Field Description
nftProjectId - String!
paymentAddress - String!
hexTransaction - String!
Example
{
  "nftProjectId": "abc123",
  "paymentAddress": "xyz789",
  "hexTransaction": "abc123"
}

SubmitBuyRandomMintTransactionPayload

Fields
Field Name Description
transactionId - String
error - SaturnError
Example
{
  "transactionId": "xyz789",
  "error": SaturnError
}

SubmitRoyaltyMintTransactionInput

Fields
Input Field Description
nftProjectId - String!
hexTransaction - String
mintEnd - DateTime
Example
{
  "nftProjectId": "xyz789",
  "hexTransaction": "xyz789",
  "mintEnd": "2007-12-03T10:15:30Z"
}

SubmitRoyaltyMintTransactionPayload

Fields
Field Name Description
transactionId - String
error - SaturnError
Example
{
  "transactionId": "xyz789",
  "error": SaturnError
}

SubmitSingleOrBulkBurnTransactionInput

Fields
Input Field Description
nftProjectId - String!
nftIds - [String!]!
paymentAddress - String!
hexTransaction - String!
Example
{
  "nftProjectId": "abc123",
  "nftIds": ["abc123"],
  "paymentAddress": "xyz789",
  "hexTransaction": "xyz789"
}

SubmitSingleOrBulkBurnTransactionPayload

Fields
Field Name Description
transactionId - String
error - SaturnError
Example
{
  "transactionId": "abc123",
  "error": SaturnError
}

SubmitSingleOrBulkMintTransactionInput

Fields
Input Field Description
nftProjectId - String!
nftIds - [String!]!
paymentAddress - String!
hexTransaction - String!
Example
{
  "nftProjectId": "abc123",
  "nftIds": ["abc123"],
  "paymentAddress": "xyz789",
  "hexTransaction": "abc123"
}

SubmitSingleOrBulkMintTransactionPayload

Fields
Field Name Description
transactionId - String
error - SaturnError
Example
{
  "transactionId": "xyz789",
  "error": SaturnError
}

TokenPrice

Fields
Field Name Description
id - UUID!
price_id - UUID!
price - Price!
token_price - Float!
token_full_name - String
token_name - String
token_image - String
token_decimals - Int!
allow_token_payment - Boolean!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "price_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "price": Price,
  "token_price": 123.45,
  "token_full_name": "xyz789",
  "token_name": "xyz789",
  "token_image": "xyz789",
  "token_decimals": 123,
  "allow_token_payment": true,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

TokenPriceInput

Fields
Input Field Description
id - UUID!
price_id - UUID!
price - PriceInput!
token_price - Float!
token_full_name - String
token_name - String
token_image - String
token_decimals - Int!
allow_token_payment - Boolean!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "price_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "price": PriceInput,
  "token_price": 123.45,
  "token_full_name": "xyz789",
  "token_name": "xyz789",
  "token_image": "abc123",
  "token_decimals": 987,
  "allow_token_payment": true,
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

UUID

Example
"ae81681e-4887-4a35-bd77-575da9353596"

UpdateNFTGeneratorInput

Fields
Input Field Description
nftGeneratorId - String!
Example
{"nftGeneratorId": "xyz789"}

UpdateNFTGeneratorPayload

Fields
Field Name Description
nftGenerator - NFTGenerator
error - SaturnError
Example
{
  "nftGenerator": NFTGenerator,
  "error": SaturnError
}

UpdateNFTInput

Fields
Input Field Description
id - String!
assetName - String
name - String
jsonProperties - String
files - [NFTFileDataInput!]
individualPrice - NFTPriceDataInput
Example
{
  "id": "xyz789",
  "assetName": "abc123",
  "name": "xyz789",
  "jsonProperties": "abc123",
  "files": [NFTFileDataInput],
  "individualPrice": NFTPriceDataInput
}

UpdateNFTPayload

Fields
Field Name Description
nft - NFT
error - SaturnError
Example
{"nft": NFT, "error": SaturnError}

UpdateNFTProjectInput

Fields
Input Field Description
nftProjectId - String!
name - String
prices - [UpdateNFTProjectPriceInput!]
mintEnd - DateTime
lockAfterDatetime - DateTime
royaltyAddress - String
royaltyPercent - Float
mintType - Int
maxPerTransaction - Int
maxPerWallet - Int
platformFeePercent - Float
minPlatformFee - Float
partnerFeePercent - Float
minPartnerFee - Float
nftProjectAddress - String
walletPublicKeyCborHex - String
walletPrivateKeyCborHex - String
Example
{
  "nftProjectId": "xyz789",
  "name": "abc123",
  "prices": [UpdateNFTProjectPriceInput],
  "mintEnd": "2007-12-03T10:15:30Z",
  "lockAfterDatetime": "2007-12-03T10:15:30Z",
  "royaltyAddress": "xyz789",
  "royaltyPercent": 987.65,
  "mintType": 987,
  "maxPerTransaction": 987,
  "maxPerWallet": 987,
  "platformFeePercent": 987.65,
  "minPlatformFee": 123.45,
  "partnerFeePercent": 123.45,
  "minPartnerFee": 987.65,
  "nftProjectAddress": "abc123",
  "walletPublicKeyCborHex": "xyz789",
  "walletPrivateKeyCborHex": "xyz789"
}

UpdateNFTProjectPayload

Fields
Field Name Description
nftProject - NFTProject
error - SaturnError
Example
{
  "nftProject": NFTProject,
  "error": SaturnError
}

UpdateNFTProjectPriceInput

Fields
Input Field Description
adaPrice - Float
allowAdaPayment - Boolean
isMainPrice - Boolean
tokenPrices - [UpdateNFTProjectTokenPriceInput!]
Example
{
  "adaPrice": 987.65,
  "allowAdaPayment": true,
  "isMainPrice": false,
  "tokenPrices": [UpdateNFTProjectTokenPriceInput]
}

UpdateNFTProjectTokenPriceInput

Fields
Input Field Description
tokenFullName - String
tokenPrice - Float
allowTokenPayment - Boolean
Example
{
  "tokenFullName": "xyz789",
  "tokenPrice": 987.65,
  "allowTokenPayment": true
}

UpdatePublicWhitelistInput

Fields
Input Field Description
publicStartTime - Long!
Example
{"publicStartTime": 456}

UpdateWhitelistDataInput

Fields
Input Field Description
id - String
name - String
whitelistPrices - [UpdateWhitelistPriceInput!]
maxNftsPerSlot - Int!
whitelistType - WhitelistType!
startTime - Long!
requiredPolicyId - String
requiredOwnedAmount - Int!
whitelistSlots - [UpdateWhitelistSlotInput!]!
Example
{
  "id": "abc123",
  "name": "abc123",
  "whitelistPrices": [UpdateWhitelistPriceInput],
  "maxNftsPerSlot": 987,
  "whitelistType": "NONE",
  "startTime": 456,
  "requiredPolicyId": "abc123",
  "requiredOwnedAmount": 123,
  "whitelistSlots": [UpdateWhitelistSlotInput]
}

UpdateWhitelistInput

Fields
Input Field Description
nftProjectId - String!
publicWhitelist - UpdatePublicWhitelistInput!
whitelists - [UpdateWhitelistDataInput!]!
Example
{
  "nftProjectId": "abc123",
  "publicWhitelist": UpdatePublicWhitelistInput,
  "whitelists": [UpdateWhitelistDataInput]
}

UpdateWhitelistPayload

Fields
Field Name Description
whitelists - [Whitelist!]
error - SaturnError
Example
{
  "whitelists": [Whitelist],
  "error": SaturnError
}

UpdateWhitelistPriceInput

Fields
Input Field Description
adaPrice - Float
allowAdaPayment - Boolean
isMainPrice - Boolean
tokenPrices - [UpdateWhitelistTokenPriceInput!]
Example
{
  "adaPrice": 987.65,
  "allowAdaPayment": false,
  "isMainPrice": true,
  "tokenPrices": [UpdateWhitelistTokenPriceInput]
}

UpdateWhitelistSlotInput

Fields
Input Field Description
id - String
address - String!
Example
{
  "id": "abc123",
  "address": "xyz789"
}

UpdateWhitelistTokenPriceInput

Fields
Input Field Description
tokenFullName - String
tokenPrice - Float
allowTokenPayment - Boolean
Example
{
  "tokenFullName": "abc123",
  "tokenPrice": 987.65,
  "allowTokenPayment": true
}

Upload

Description

The Upload scalar type represents a file upload.

Example
Upload

UploadNFTImagesInput

Fields
Input Field Description
nftProjectId - String!
files - [NFTFileDataInput!]
Example
{
  "nftProjectId": "abc123",
  "files": [NFTFileDataInput]
}

UploadNFTImagesPayload

Fields
Field Name Description
nftProject - NFTProject
link - String
error - SaturnError
Example
{
  "nftProject": NFTProject,
  "link": "xyz789",
  "error": SaturnError
}

UploadNFTMetadataInput

Fields
Input Field Description
nftProjectId - String!
beginIndex - Long!
endIndex - Long!
nftMetadatas - [AddNFTMetdataInput!]!
Example
{
  "nftProjectId": "xyz789",
  "beginIndex": 456,
  "endIndex": 456,
  "nftMetadatas": [AddNFTMetdataInput]
}

UploadNFTMetadataPayload

Fields
Field Name Description
nftProject - NFTProject
link - String
error - SaturnError
Example
{
  "nftProject": NFTProject,
  "link": "xyz789",
  "error": SaturnError
}

Wallet

Fields
Field Name Description
id - UUID!
account_id - UUID!
nft_project_id - UUID
nft_project - NFTProject
name - String
blockchain - Blockchain!
network - Network!
address - String!
is_payment - Boolean!
mnemonic - String
key_type - KeyType
public_key - String
private_key - String
public_payment_key - String
private_payment_key - String
public_stake_key - String
private_stake_key - String
account_index - Int
key_index - Int
wallet_type - WalletType!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "account_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project": NFTProject,
  "name": "abc123",
  "blockchain": "NONE",
  "network": "PREPROD",
  "address": "abc123",
  "is_payment": false,
  "mnemonic": "abc123",
  "key_type": "EXTERNAL",
  "public_key": "abc123",
  "private_key": "abc123",
  "public_payment_key": "abc123",
  "private_payment_key": "xyz789",
  "public_stake_key": "abc123",
  "private_stake_key": "xyz789",
  "account_index": 123,
  "key_index": 987,
  "wallet_type": "INTERNAL",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

WalletInput

Fields
Input Field Description
id - UUID!
account_id - UUID!
nft_project_id - UUID
nft_project - NFTProjectInput
name - String
blockchain - Blockchain!
network - Network!
address - String!
is_payment - Boolean!
mnemonic - String
key_type - KeyType
public_key - String
private_key - String
public_payment_key - String
private_payment_key - String
public_stake_key - String
private_stake_key - String
account_index - Int
key_index - Int
wallet_type - WalletType!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "account_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project": NFTProjectInput,
  "name": "abc123",
  "blockchain": "NONE",
  "network": "PREPROD",
  "address": "abc123",
  "is_payment": true,
  "mnemonic": "xyz789",
  "key_type": "EXTERNAL",
  "public_key": "xyz789",
  "private_key": "xyz789",
  "public_payment_key": "xyz789",
  "private_payment_key": "xyz789",
  "public_stake_key": "abc123",
  "private_stake_key": "xyz789",
  "account_index": 123,
  "key_index": 987,
  "wallet_type": "INTERNAL",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

WalletType

Values
Enum Value Description

INTERNAL

EXTERNAL

APPLICATION

Example
"INTERNAL"

Whitelist

Fields
Field Name Description
id - UUID!
nft_project_mint_id - UUID!
nft_project_mint - NFTProjectMint!
whitelist_type - WhitelistType!
name - String
collection_id - Long!
start_time - Long!
end_time - Long
max_nfts_per_slot - Int!
whitelist_prices - [Price!]!
required_policy_id - String
required_owned_amount - Int!
whitelist_slots - [WhitelistSlot!]!
whitelist_started_time - DateTime
whitelist_ended_time - DateTime
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_mint_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_mint": NFTProjectMint,
  "whitelist_type": "NONE",
  "name": "abc123",
  "collection_id": 456,
  "start_time": 456,
  "end_time": 456,
  "max_nfts_per_slot": 987,
  "whitelist_prices": [Price],
  "required_policy_id": "abc123",
  "required_owned_amount": 123,
  "whitelist_slots": [WhitelistSlot],
  "whitelist_started_time": "2007-12-03T10:15:30Z",
  "whitelist_ended_time": "2007-12-03T10:15:30Z",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

WhitelistInput

Fields
Input Field Description
id - UUID!
nft_project_mint_id - UUID!
nft_project_mint - NFTProjectMintInput!
whitelist_type - WhitelistType!
name - String
collection_id - Long!
start_time - Long!
end_time - Long
max_nfts_per_slot - Int!
whitelist_prices - [PriceInput!]!
required_policy_id - String
required_owned_amount - Int!
whitelist_slots - [WhitelistSlotInput!]!
whitelist_started_time - DateTime
whitelist_ended_time - DateTime
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_mint_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_project_mint": NFTProjectMintInput,
  "whitelist_type": "NONE",
  "name": "xyz789",
  "collection_id": 456,
  "start_time": 456,
  "end_time": 456,
  "max_nfts_per_slot": 987,
  "whitelist_prices": [PriceInput],
  "required_policy_id": "xyz789",
  "required_owned_amount": 987,
  "whitelist_slots": [WhitelistSlotInput],
  "whitelist_started_time": "2007-12-03T10:15:30Z",
  "whitelist_ended_time": "2007-12-03T10:15:30Z",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

WhitelistSlot

Fields
Field Name Description
id - UUID!
whitelist_id - UUID!
whitelist - Whitelist!
whitelist_slot_type - WhitelistType!
address - String
stake_address - String
policy_id - String
asset_name - String
full_asset_name - String
whitelist_slot_mints - [WhitelistSlotMint!]!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "whitelist_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "whitelist": Whitelist,
  "whitelist_slot_type": "NONE",
  "address": "xyz789",
  "stake_address": "abc123",
  "policy_id": "abc123",
  "asset_name": "abc123",
  "full_asset_name": "xyz789",
  "whitelist_slot_mints": [WhitelistSlotMint],
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

WhitelistSlotInput

Fields
Input Field Description
id - UUID!
whitelist_id - UUID!
whitelist - WhitelistInput!
whitelist_slot_type - WhitelistType!
address - String
stake_address - String
policy_id - String
asset_name - String
full_asset_name - String
whitelist_slot_mints - [WhitelistSlotMintInput!]!
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "whitelist_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "whitelist": WhitelistInput,
  "whitelist_slot_type": "NONE",
  "address": "xyz789",
  "stake_address": "abc123",
  "policy_id": "xyz789",
  "asset_name": "xyz789",
  "full_asset_name": "abc123",
  "whitelist_slot_mints": [WhitelistSlotMintInput],
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

WhitelistSlotMint

Fields
Field Name Description
id - UUID!
whitelist_slot_id - UUID!
whitelist_slot - WhitelistSlot!
nft_mint_id - UUID
nft_mint - NFTMint
whitelist_slot_mint_status - WhitelistSlotMintStatus!
status_timestamp - DateTime
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "whitelist_slot_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "whitelist_slot": WhitelistSlot,
  "nft_mint_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_mint": NFTMint,
  "whitelist_slot_mint_status": "NONE",
  "status_timestamp": "2007-12-03T10:15:30Z",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

WhitelistSlotMintInput

Fields
Input Field Description
id - UUID!
whitelist_slot_id - UUID!
whitelist_slot - WhitelistSlotInput!
nft_mint_id - UUID
nft_mint - NFTMintInput
whitelist_slot_mint_status - WhitelistSlotMintStatus!
status_timestamp - DateTime
created_at - DateTime
updated_at - DateTime
Example
{
  "id": "ae81681e-4887-4a35-bd77-575da9353596",
  "whitelist_slot_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "whitelist_slot": WhitelistSlotInput,
  "nft_mint_id": "ae81681e-4887-4a35-bd77-575da9353596",
  "nft_mint": NFTMintInput,
  "whitelist_slot_mint_status": "NONE",
  "status_timestamp": "2007-12-03T10:15:30Z",
  "created_at": "2007-12-03T10:15:30Z",
  "updated_at": "2007-12-03T10:15:30Z"
}

WhitelistSlotMintStatus

Values
Enum Value Description

NONE

CREATING_TRANSACTION

AWAITING_SIGNATURE

SUBMITTING_TRANSACTION

PENDING

COMPLETE

CANCELLED

FAILED

Example
"NONE"

WhitelistType

Values
Enum Value Description

NONE

DYNAMIC

STATIC

Example
"NONE"