Dashboard

System Status

Community

Lumx Protocol

Guide

API Reference

Extensions

Start now

Support

Create a wallet

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

Transactions

Webhooks

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

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 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

Read a contract function

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

Enhance Lumx Protocol capabilities with third-party integrations

Execute payins and payouts, converting between stablecoins and local currencies

Overview

Enhance your protocol capabilities with third-party integrations

Create a wallet

Authorizations

Response