Ticbolt API Integration
  • Introduction
  • ✨GET STARTED
    • Create Account
    • Create API project
    • Access control
  • 🎯API ENDPOINTS
    • POST - createEvent
    • GET - eventInfo
    • POST - buyTickets
    • GET - userPortfolio
    • POST - userSignedMessage
  • 🧳Webhooks
    • Webhook - createEventStatus
    • Webhook - buyTicketStatus
Powered by GitBook
On this page
  1. API ENDPOINTS

GET - userPortfolio

A user's portfolio consists of all NFTs and Merchandise items that they own.

Http method

GET

URL endpoint

https://api.ticbolt.com/v1/userPortfolio

Request header

API token - The token can be easily copied from the partner dashboard for the project created.

Request body

Json object with the details of the event to be created.

Example structure :

{
    "emailAddress" : "[email protected]"
}

Parameter description :

  • userEmailAddress (String): The email address of the user making the purchase.

Response:

The API will respond with a JSON payload. Depending on the outcome of the request, the structure will differ:

Successful Response:

{
    "status": "success",
    "nfts": [
        {
            "contractAddress": "0xabcde12345...",
            "nftId": "1234...",
            "ticketType": "VIP",
            "seated": true,
            "seat": "A1",
            "nftType": "ticket"
        },
        {
            "contractAddress": "0xabcde12345...",
            "nftId": "5678...",
            "nftType": "merchandise"
        },
        ... // Other NFTs
    ]
}

Parameter description :

On a successful request, the response will have the following parameters :

  • contractAddress (String): The contract address of the event.

  • nftid (String) : The nftId of the Nft ticket or merchandise created for a user.

  • ticketType (String) : If the item is a ticket, this field indicates its type (e.g., "VIP", "Regular").

  • seated (Boolean) : A boolean value indicating if the ticket is for a seated arrangement. This field is present only for tickets.

  • seat: The specific seat number assigned to the ticket, if applicable.seat: The specific seat number assigned to the ticket, if applicable.

  • nftType: Specifies the type of NFT. It can be either "ticket" or "merchandise".

Failed Response:

{
    "status": "fail",
    "message": "Descriptive error message"
}

Error Response:

{
    "status": "error",
    "message": "Exception or error message"
}
PreviousPOST - buyTicketsNextPOST - userSignedMessage

Last updated 1 year ago

🎯