Search…
⌃K
Links

API Swagger

Use the Swagger to test the API on main and testnet
What is the Swagger
Swagger is a web-based user interface that allows you to test all API Method Calls. All of the code is pre-written, allowing you to 'drop in' your specific parameters and verify that the results are as expected before taking the time to implement it yourself. You can also use Swagger to better understand any errors you may be experiencing, and we recommend that you do so before contacting our support teams.

Interface Structure

You will also see that each method can be expanded to reveal various useful options and information:
  • Description
  • Parameters
    • These are the inputs required for this specific method call
  • Possible Responses
    • These are all of the possible, pre defined HTTP response codes + data that the API will respond with, based on the result of your attempted method call
  • Try-it-out
    • Execute
      • Run the test method call
    • Actual Response
      • The Specific HTTP Response to this specific attempted method call

Using the Swagger

To learn how to use the swagger, please read Getting Started with the Swagger and Swagger Responses and Error Codes.
Note - the Project and NFT UID's are now both random strings that cannot be predicted, this extra security feature means that attackers cannot 'guess' the ID, making certain attacks more difficult even if the API Key is compromised.
Note - NEVER EXPOSE YOUR API KEY, IF YOU DO, DELETE IT AND MAKE A NEW ONE IMMEDIATELY.

Swagger Mainnet

Swagger Testnet (preprod)