Join our Discord

System Status

Github

Lumx Protocol

Guides

API Reference

Read a contract function

apiKey

Introduction

Learn how to authenticate yourself on the Protocol

Authentication

Multiple enviroments with multiple purposes

Environments

Choose the best blockchain to fit your project

Blockchains

Find out the common extended error messages you may encounter while using our system.

Troubleshooting

Protocol

Wallets

Contracts

Transaction

Webhook

Find out what you can achieve with Lumx Protocol

Learn how to create a project and receive an API key

Get an API key

Your first contract

Create a wallet

Mint a token

The road so far

Transfer a token

Invoke a custom transaction

Learn how to register a webhook on the Lumx dashboard

Register a Webhook

This endpoint creates a project and an API key.

Create a project

This endpoint reads a wallet and returns a list of all tokens contained within it

Read a wallet

Read all wallets

Use this endpoint to sign a message to prove wallet ownership.

Sign a message

This endpoint creates a contract. Please, remember to deploy the contract before interacting with it.

Create a contract

Update a contract

Deploy a contract

Read a contract

Read all contracts

This endpoint creates a token type for a contract.

Create a token type

This endpoint update a token type of a contract.

Update a token type

This endpoint reads a token type from a contract.

Read a token type

This endpoint reads all token type from a contract.

Read all token types

Mint one or multiple tokens and send them to a wallet. Important: This is an ASYNC route! Use the read transaction route to check the mint's status.

Mint tokens

Transfer tokens from a wallet. Important: This is an ASYNC route! Use the read transaction route to check the transfer's status.

Transfer tokens

This endpoint reads a transaction made with your API key.

Read a transaction

This endpoint reads all transactions made with your API key.

Read all transactions

Use this route to obtain an API key. In production environments, you will need a one time password in order to get a key.

Get account details

This endpoint reads the id and address of all wallets associated with your API key.

This endpoint reads the tokens that belong to a wallet

This endpoint creates a contract, but doesn't deploy it. Use the "Deploy a contract" endpoint to create the contract on the blockchain.

This endpoint deploys a contract to the blockchain. A successfull 202 response means the contract is currently being deployed to the blockchain. Use the read contract route to get the contract's address.

Read all item types

Create an item type

Read an item type

Update an item type

Mint one or multiple tokens and send them to a wallet

Invoke custom transactions

This endpoint reads all transactions made with your API key. DISCLAIMER: currently only returns mints, will return transfers soon.

This endpoint reads a transaction made with your API key. DISCLAIMER: currently only works for mints, will return transfers soon.

Projects

Wallets

Contracts

Transactions

Read a contract function

Authorizations

Body

Response