📘
Please note: This is an introductory reference
For the most up-to-date information, refer to the GraphQL Playground and Apollo API Reference.
🚧 The information provided in this section cannot be programmatically updated and may be subject to inconsistencies over time.

👍
Marketplace Endpoints

Testnet: http://platform.canary.enjin.io/graphql/marketplace

Mainnet: http://platform.enjin.io/graphql/marketplace

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

Queries

GetBid

The GetBid query allows you to retrieve detailed information about a specific bid placed on a market listing. It's a valuable tool for querying bid-related data, including bid price, bidder details, and the associated market listing.

query GetBid {
  GetBid(id: 1) {
    id
    price
    height
    bidder {
      account {
        publicKey
        address
      }
    }
    listing {
      listingId
    }
  }
}

{
  "data": {
    "GetBid": {
      "id": 1,
      "price": "1000000000000000000",
      "height": 239058,
      "bidder": {
        "account": {
          "publicKey": "0xb4664455021025f4944c1bc4af8a2830317f0765dc624778345dea09e89a526a",
          "address": "cxNW84hdDPEr8rU8oUbqNDaCmVX6SxH86mFufTf6HiNbZhi2F"
        }
      },
      "listing": {
        "listingId": "0x101d16dc0fa25d77a92bcb6cde34e8ad1e85d96cd6a4a78eb68acc4f82d37f20"
      }
    }
  }
}

Use Case:

The GetBid query serves various use cases:

Audit and Verification: You can use it to verify and audit bid details, ensuring transparency and accountability.
Market Analysis: It aids in analyzing market behavior, helping you understand bidding patterns and the market value of listings.
User Interface Updates: Developers can use this data to update user interfaces with real-time bid information. This enhances the user experience by keeping users informed about their bids or bids on listings they are interested in.

By providing access to bid-related data, the GetBid query is a fundamental tool for applications and systems that involve marketplaces and bidding processes.

GetBids

The GetBids query is used to retrieve a list of bids for one or more market listings based on specified listing IDs. Unlike the GetBid query, which retrieves details of a single bid, GetBids can return multiple bids and includes pagination information.

query GetBids {
  GetBids(listingIds: ["0x101d16dc0fa25d77a92bcb6cde34e8ad1e85d96cd6a4a78eb68acc4f82d37f20"]) {
    totalCount
    pageInfo {
      startCursor
      endCursor
      hasPreviousPage
      hasNextPage
    }
    edges {
      node {
        id
        price
        height
        bidder {
          account {
            publicKey
            address
          }
        }
        listing {
          listingId
        }
      }
    }
  }
}

{
  "data": {
    "GetBids": {
      "totalCount": 1,
      "pageInfo": {
        "startCursor": "",
        "endCursor": "",
        "hasPreviousPage": false,
        "hasNextPage": false
      },
      "edges": [
        {
          "node": {
            "id": 1,
            "price": "1000000000000000000",
            "height": 239058,
            "bidder": {
              "account": {
                "publicKey": "0xb4664455021025f4944c1bc4af8a2830317f0765dc624778345dea09e89a526a",
                "address": "cxNW84hdDPEr8rU8oUbqNDaCmVX6SxH86mFufTf6HiNbZhi2F"
              }
            },
            "listing": {
              "listingId": "0x101d16dc0fa25d77a92bcb6cde34e8ad1e85d96cd6a4a78eb68acc4f82d37f20"
            }
          }
        }
      ]
    }
  }
}

Use Case:

The GetBids query serves various use cases:

Marketplace Insights: You can use it to gain insights into the market by retrieving bid data for multiple listings. This helps you understand the level of activity and interest in various listings.
Data Analysis: The retrieved data can be used for statistical analysis, trend identification, and understanding how the market responds to different listings.
User Interface: For platforms displaying lists of bids on multiple items, this query ensures that users have access to comprehensive bid information across various listings.

While the GetBid query focuses on retrieving detailed information about a single bid, GetBids is suitable for scenarios where you need an overview of all bids related to specific listings, especially when dealing with a larger volume of bid data.

GetListing

The GetListing query allows you to retrieve detailed information about a single market listing using its unique listing ID. This query provides a comprehensive overview of the listing's attributes, its state, sales history, bid history, and more.

query GetListing {
  GetListing(listingId: "0x101d16dc0fa25d77a92bcb6cde34e8ad1e85d96cd6a4a78eb68acc4f82d37f20") {
    listingId
    makeAssetId {
      collectionId
      tokenId
    }
    takeAssetId {
      collectionId
      tokenId
    }
    amount
    price
    minTakeValue
    feeSide
    creationBlock
    deposit
    salt
    state {
      ... on FixedPriceState {
        amountFilled
        type
      }
      ... on AuctionState {
        type
      }
    }
    data {
      ... on FixedPriceData {
        type
      }
      ... on AuctionData {
        type
        startBlock
        endBlock
      }
    }
    seller {
      account {
        publicKey
        address
      }
    }
    sales {
      edges {
        node {
          amount
          price
          bidder {
            account {
              publicKey
              address
            }
          }
        }
      }
    }
    bids {
      edges {
        node {
          price
          bidder {
            account {
              publicKey
              address
            }
          }
          height
        }
      }
    }
    states {
      state
      height
    }
  }
}

{
  "data": {
    "GetListing": {
      "listingId": "0x101d16dc0fa25d77a92bcb6cde34e8ad1e85d96cd6a4a78eb68acc4f82d37f20",
      "makeAssetId": {
        "collectionId": "4919",
        "tokenId": "0"
      },
      "takeAssetId": {
        "collectionId": "0",
        "tokenId": "0"
      },
      "amount": "1",
      "price": "1000000000000000000",
      "minTakeValue": "975000000000000000",
      "feeSide": "TAKE_FEE",
      "creationBlock": 239058,
      "deposit": "2025700000000000000",
      "salt": "73616c74313233",
      "state": {
        "amountFilled": null,
        "type": "FIXED_PRICE"
      },
      "data": {
        "type": "FIXED_PRICE"
      },
      "seller": {
        "account": {
          "publicKey": "0x087c3fdc6566230578362759d99e42ed300f5560c305262843b2c61aa2f1d11e",
          "address": "cxJciMkfdBqR8C9ftA8qmgzP9bAQNzMzXZmwUDZ2qW5mFVgvm"
        }
      },
      "sales": {
        "edges": []
      },
      "bids": {
        "edges": [
          {
            "node": {
              "price": "1000000000000000000",
              "bidder": {
                "account": {
                  "publicKey": "0xb4664455021025f4944c1bc4af8a2830317f0765dc624778345dea09e89a526a",
                  "address": "cxNW84hdDPEr8rU8oUbqNDaCmVX6SxH86mFufTf6HiNbZhi2F"
                }
              },
              "height": 239058
            }
          }
        ]
      },
      "states": [
        {
          "state": "ACTIVE",
          "height": 239058
        }
      ]
    }
  }
}

Use Case:

The GetListing query is valuable for various use cases:

Detailed Listing Information: You can retrieve all essential information about a specific listing, making it useful for potential buyers to review listing details comprehensively.
Historical Data Analysis: It includes historical states, sales, and bids, enabling users to track the listing's activity over time and analyze its market performance.
Transaction Preparation: Sellers and buyers can prepare for transactions effectively by understanding the listing's terms, including price, minimum take value, and asset details.

Unlike queries like GetBids that focus on specific aspects of a listing, GetListing provides a holistic view of a single market listing, encapsulating all its attributes, history, and context in a single response. This makes it particularly useful for in-depth research and transaction preparation.

GetListings

The GetListings query is used to retrieve information about multiple market listings from the Enjin Blockchain marketplace. Unlike the GetListing query, which fetches data for a single listing, GetListings is designed to handle multiple listings at once, making it suitable for scenarios where you need to fetch details for multiple listings in a single request.

query GetListings {
  GetListings(
    listingIds: ["0x101d16dc0fa25d77a92bcb6cde34e8ad1e85d96cd6a4a78eb68acc4f82d37f20"]
  ) {
    totalCount
    pageInfo {
      startCursor
      endCursor
      hasPreviousPage
      hasNextPage
    }
    edges {
      node {
        listingId
        makeAssetId {
          collectionId
          tokenId
        }
        takeAssetId {
          collectionId
          tokenId
        }
        amount
        price
        minTakeValue
        feeSide
        creationBlock
        deposit
        salt
        state {
          ... on FixedPriceState {
            amountFilled
            type
          }
          ... on AuctionState {
            type
          }
        }
        data {
          ... on FixedPriceData {
            type
          }
          ... on AuctionData {
            type
            startBlock
            endBlock
          }
        }
        seller {
          account {
            publicKey
            address
          }
        }
        sales {
          edges {
            node {
              amount
              price
              bidder {
                account {
                  publicKey
                  address
                }
              }
            }
          }
        }
        bids {
          edges {
            node {
              price
              bidder {
                account {
                  publicKey
                  address
                }
              }
              height
            }
          }
        }
        states {
          state
          height
        }
      }
    }
  }
}

{
  "data": {
    "GetListings": {
      "totalCount": 1,
      "pageInfo": {
        "startCursor": "",
        "endCursor": "",
        "hasPreviousPage": false,
        "hasNextPage": false
      },
      "edges": [
        {
          "node": {
            "listingId": "0x101d16dc0fa25d77a92bcb6cde34e8ad1e85d96cd6a4a78eb68acc4f82d37f20",
            "makeAssetId": {
              "collectionId": "4919",
              "tokenId": "0"
            },
            "takeAssetId": {
              "collectionId": "0",
              "tokenId": "0"
            },
            "amount": "1",
            "price": "1000000000000000000",
            "minTakeValue": "975000000000000000",
            "feeSide": "TAKE_FEE",
            "creationBlock": 239058,
            "deposit": "2025700000000000000",
            "salt": "73616c74313233",
            "state": {
              "amountFilled": null,
              "type": "FIXED_PRICE"
            },
            "data": {
              "type": "FIXED_PRICE"
            },
            "seller": {
              "account": {
                "publicKey": "0x087c3fdc6566230578362759d99e42ed300f5560c305262843b2c61aa2f1d11e",
                "address": "cxJciMkfdBqR8C9ftA8qmgzP9bAQNzMzXZmwUDZ2qW5mFVgvm"
              }
            },
            "sales": {
              "edges": []
            },
            "bids": {
              "edges": [
                {
                  "node": {
                    "price": "1000000000000000000",
                    "bidder": {
                      "account": {
                        "publicKey": "0xb4664455021025f4944c1bc4af8a2830317f0765dc624778345dea09e89a526a",
                        "address": "cxNW84hdDPEr8rU8oUbqNDaCmVX6SxH86mFufTf6HiNbZhi2F"
                      }
                    },
                    "height": 239058
                  }
                }
              ]
            },
            "states": [
              {
                "state": "ACTIVE",
                "height": 239058
              }
            ]
          }
        }
      ]
    }
  }
}

Use Case:

The GetListings query is valuable for various use cases:

Batch Data Retrieval: You can efficiently retrieve detailed information about multiple listings in a single request, which is useful for batch processing or displaying a list of items on a user interface.
Marketplace Overview: It allows you to obtain a comprehensive overview of multiple listings, making it easier to analyze and present marketplace data to users.
Pagination Support: GetListings provides pagination details, making it suitable for handling large datasets of listings.

Compared to the GetListing query, which focuses on a single listing, GetListings is designed to cater to scenarios where you need to work with multiple listings simultaneously. It streamlines the data retrieval process, especially when dealing with large sets of listings, and includes pagination support for handling extensive listings efficiently.

GetSale

The GetSale query is used to retrieve details about a specific sale transaction that has occurred on the Enjin Blockchain marketplace. This query requires the sale ID as input and returns information about the sale, including the sale ID, price, quantity, bidder information, and the associated market listing.

query GetSale {
  GetSale(id: 1) {
    id
    price
    amount
    bidder {
      account {
        publicKey
        address
      }
    }
    listing {
      listingId
    }
  }
}

{
  "data": {
    "GetSale": {
      "id": 1,
      "price": "1000000",
      "amount": "1",
      "bidder": {
        "account": {
          "publicKey": "0x6a03b1a3d40d7e344dfb27157931b14b59fe2ff11d7352353321fe400e956802",
          "address": "cxLpbEojWougf2cE6onB6PuK9SsfmKqNJKNo9tTsqirxFbuN5"
        }
      },
      "listing": {
        "listingId": "0x101d16dc0fa25d77a92bcb6cde34e8ad1e85d96cd6a4a78eb68acc4f82d37f20"
      }
    }
  }
}

Use Case:

The GetSale query serves various purposes in a marketplace:

Transaction Verification: You can use it to verify and retrieve specific details of a sale transaction, including the price, quantity, and bidder information. This is essential for transparency and auditing purposes.
Marketplace Analytics: By providing sale details, this query aids in market analysis, allowing you to understand the pricing and quantity dynamics within the marketplace.
User Interface Updates: Applications can use this data to update user interfaces with the latest sale information, enhancing user experience by keeping them informed about completed transactions.
Historical Data Retrieval: It allows you to access historical sale data, which can be valuable for historical analysis and reporting.

Overall, the GetSale query helps you retrieve and display specific details about completed sale transactions in a marketplace.

GetSales

The GetSales query is used to retrieve information about completed sale transactions that have occurred on a marketplace. This query allows you to fetch details of multiple sales associated with specific market listings.

query GetSales {
  GetSales(listingIds: ["0x101d16dc0fa25d77a92bcb6cde34e8ad1e85d96cd6a4a78eb68acc4f82d37f20"]) {
    totalCount
    pageInfo {
      startCursor
      endCursor
      hasPreviousPage
      hasNextPage
    }
    edges {
      node {
        id
        price
        amount
        bidder {
          account {
            publicKey
            address
          }
        }
        listing {
          listingId
        }
      }
    }
  }
}

{
  "data": {
    "GetSales": {
      "totalCount": 1,
      "pageInfo": {
        "startCursor": "",
        "endCursor": "",
        "hasPreviousPage": false,
        "hasNextPage": false
      },
      "edges": [
        {
          "node": {
            "id": 1,
            "price": "1000000",
            "amount": "1",
            "bidder": {
              "account": {
                "publicKey": "0x6a03b1a3d40d7e344dfb27157931b14b59fe2ff11d7352353321fe400e956802",
                "address": "cxLpbEojWougf2cE6onB6PuK9SsfmKqNJKNo9tTsqirxFbuN5"
              }
            },
            "listing": {
              "listingId": "0x101d16dc0fa25d77a92bcb6cde34e8ad1e85d96cd6a4a78eb68acc4f82d37f20"
            }
          }
        }
      ]
    }
  }
}

Use Case:

The GetSales query serves various purposes in a marketplace:

Transaction History: It allows you to retrieve a history of completed sale transactions associated with specific market listings. This is valuable for auditing and transparency.
Marketplace Analytics: By fetching completed sale details, you can analyze pricing trends, quantity dynamics, and bidder behaviors within the marketplace.
User Interface Updates: Applications can use this data to display the history of sales to users, helping them track the transaction history of specific listings.
Transaction Confirmation: Sellers and buyers can use this query to confirm the details of completed transactions, including the sale price and bidder information.

Overall, the GetSales query is instrumental in providing insights into the history of completed sale transactions within a marketplace. It offers a comprehensive view of completed sales associated with specific market listings, aiding in transparency and informed decision-making.

Marketplace

📘
Please note: This is an introductory reference

👍
Marketplace Endpoints

Queries

GetBid

Use Case:

GetBids

Use Case:

GetListing

Use Case:

GetListings

Use Case:

GetSale

Use Case:

GetSales

Use Case:

📘Please note: This is an introductory reference

👍Marketplace Endpoints

Queries

GetBid

Use Case:

GetBids

Use Case:

GetListing

Use Case:

GetListings

Use Case:

GetSale

Use Case:

GetSales

Use Case:

📘
Please note: This is an introductory reference

👍
Marketplace Endpoints