Skip to main content
Documentation Powered by Redocly

Mazzaroth API (0.8.0)

Download OpenAPI specification:Download

E-mail: dev@mazzaroth.io

This API describes how to interact with a Mazzaroth Node.

channels

Lookup information about a channel

Retrieve the channel contract object

path Parameters
channelId
required
string

Channel to retrieve contract for.

Responses

Request samples 

curl --request GET \
--url 'http://localhost:6299/v1/channels/0000000000000000000000000000000000000000000000000000000000000000/contract' \
--header 'content-type: application/json'

Response samples

Content type
application/json
{
  • "type": 8,
  • "data": {
    }
}

Retrieve the channel contract abi

path Parameters
channelId
required
string

Channel to retrieve abi for.

Responses

Request samples 

curl --request GET \
--url 'http://localhost:6299/v1/channels/0000000000000000000000000000000000000000000000000000000000000000/abi' \
--header 'content-type: application/json'

Response samples

Content type
application/json
{
  • "type": 10,
  • "data": {
    }
}

transactions

Submit a Transaction to a node or lookup transactions

Submit a transaction to a node

path Parameters
channelId
required
string

Channel to target.

Request Body schema: application/json

Transaction to submit

signature
string

The 128 character hex representation of a 64 byte Ed25519 signature created by signing the action XDR object.

sender
string

The 64 character hex representation of a 32 byte Ed25519 public key of the sender for the transaction.

object

Responses

Request samples

Content type
application/json
{
  • "signature": "string",
  • "sender": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "type": 1,
  • "data": "string"
}

Get information about a specific Transaction

path Parameters
channelId
required
string

Channel to retrieve contract for.

transactionId
required
string

ID of the transaction to receive.

Responses

Request samples 

curl --request GET \
--url 'http://localhost:6299/v1/channels/0000000000000000000000000000000000000000000000000000000000000000/transactions/0000000000000000000000000000000000000000000000000000000000000000' \
--header 'content-type: application/json'

Response samples

Content type
application/json
{
  • "type": 2,
  • "data": {
    }
}

receipts

Get the receipt for a transaction

Retrieve the Receipt for a given Transaction

path Parameters
channelId
required
string

Channel to retrieve contract for.

transactionId
required
string

ID of the transaction to receive receipt for.

Responses

Request samples 

curl --request GET \
--url 'http://localhost:6299/v1/channels/0000000000000000000000000000000000000000000000000000000000000000/receipts/0000000000000000000000000000000000000000000000000000000000000000' \
--header 'content-type: application/json'

Response samples

Content type
application/json
{
  • "type": 3,
  • "data": {
    }
}

blocks

Get block information from a node

Get block information from a node

path Parameters
channelId
required
string

Channel to retrieve block for.

blockID
required
string

ID of the block to retrieve.

Responses

Request samples 

curl --request GET \
--url 'http://localhost:6299/v1/channels/0000000000000000000000000000000000000000000000000000000000000000/blocks/0000000000000000000000000000000000000000000000000000000000000000' \
--header 'content-type: application/json'

Response samples

Content type
application/json
{
  • "type": 4,
  • "data": {
    }
}

Get blocks from a node

path Parameters
channelId
required
string

Channel to retrieve blocks for.

query Parameters
number
integer

The number of blocks to return.

height
integer

The lowest block height to start block list from.

Responses

Request samples 

curl --request GET \
--url 'http://localhost:6299/v1/channels/0000000000000000000000000000000000000000000000000000000000000000/blocks?number=1&height=0' \
--header 'content-type: application/json'

Response samples

Content type
application/json
{
  • "type": 5,
  • "data": [
    ]
}

Get block height from a node

path Parameters
channelId
required
string

Channel to retrieve block height for.

Responses

Request samples 

curl --request GET \
--url 'http://localhost:6299/v1/channels/0000000000000000000000000000000000000000000000000000000000000000/blocks/height' \
--header 'content-type: application/json'

Response samples

Content type
application/json
{
  • "type": 9,
  • "data": {
    }
}

blockheaders

Get block header information from a node

Get block header information from a node

path Parameters
channelId
required
string

Channel to retrieve block header for.

blockID
required
string

ID of the block to retrieve header for.

Responses

Request samples 

curl --request GET \
--url 'http://localhost:6299/v1/channels/0000000000000000000000000000000000000000000000000000000000000000/blockheaders/0000000000000000000000000000000000000000000000000000000000000000' \
--header 'content-type: application/json'

Response samples

Content type
application/json
{
  • "type": 6,
  • "data": {
    }
}

Get block headers from a node

path Parameters
channelId
required
string

Channel to retrieve blocks for.

query Parameters
number
integer

The number of block headers to return.

height
integer

The lowest block height to start block header list from.

Responses

Request samples 

curl --request GET \
--url 'http://localhost:6299/v1/channels/0000000000000000000000000000000000000000000000000000000000000000/blockheaders?number=1&height=0' \
--header 'content-type: application/json'

Response samples

Content type
application/json
{
  • "type": 7,
  • "data": [
    ]
}