Ctrlk
Website
For the complete documentation index, see llms.txt. This page is also available as Markdown.

MNEE API

Welcome to the MNEE API Reference! This section provides detailed information about the available methods, parameters, and responses for interacting directly with the MNEE API. The API is designed to be intuitive and easy to use, allowing you to manage and take full control of your integration.

Notice that you can click "Test It" on the right side of the api docs. Once the testing interface opens, you can switch between the sandbox endpoint and the production endpoint by clicking the URL up top. You will need to enter your API KEY for the auth_token

Get config

get
/v1/config

Get MNEE configuration and fee structure

Authorizations
auth_tokenstringRequired
Responses
200

OK

application/json
approverstringOptionalExample: 02bed35e894cc41cc9879b4002ad03d33533b615c1b476068c8dd6822a09f93f6c
decimalsintegerOptionalExample: 5
feeAddressstringOptionalExample: 1H9wgHCTHjmgBw4PAbQ4PQBQhGFrHWhjbU
burnAddressstringOptionalExample: 1HNuPi9Y7nMV6x8crJ6DnD1wJtkLym8EFE
mintAddressstringOptionalExample: 1AZNdbFYBDFTAEgzZMfPzANxyNrpGJZAUY
tokenIdstringOptionalExample: 833a7720966a2a435db28d967385e8aa7284b6150ebb39482cc5228b73e1703f_0
get/v1/config
GET /v1/config HTTP/1.1
Host: sandbox-proxy-api.mnee.net
Accept: */*

{
  "approver": "02bed35e894cc41cc9879b4002ad03d33533b615c1b476068c8dd6822a09f93f6c",
  "decimals": 5,
  "feeAddress": "1H9wgHCTHjmgBw4PAbQ4PQBQhGFrHWhjbU",
  "burnAddress": "1HNuPi9Y7nMV6x8crJ6DnD1wJtkLym8EFE",
  "mintAddress": "1AZNdbFYBDFTAEgzZMfPzANxyNrpGJZAUY",
  "fees": [
    {
      "fee": 1000,
      "max": 1000000,
      "min": 10000
    }
  ],
  "tokenId": "833a7720966a2a435db28d967385e8aa7284b6150ebb39482cc5228b73e1703f_0"
}

Get all MNEE transactions

get
/v1/sync

Gather a list of all MNEE transactions

Authorizations
auth_tokenstringRequired
Query parameters
fromintegerOptional

Min score

limitintegerOptional

Maximum number of transactions to return

Default: 1000
Responses
200

Signed transactions

application/json
blkHashstringOptional
blkTimeintegerOptional
heightintegerOptionalExample: 800000
idxintegerOptionalExample: 1
outsinteger[]Optional
rawtxstringOptionalExample: base64 encoded rawtx
receiversstring[]Optional
scorenumberOptionalExample: 800000000000001
sendersstring[]Optional
txidstringOptional
get/v1/sync
GET /v1/sync HTTP/1.1
Host: sandbox-proxy-api.mnee.net
Accept: */*

[
  {
    "blkHash": "text",
    "blkTime": 1,
    "height": 800000,
    "idx": 1,
    "outs": [
      1
    ],
    "rawtx": "base64 encoded rawtx",
    "receivers": [
      "text"
    ],
    "score": 800000000000001,
    "senders": [
      "text"
    ],
    "txid": "text"
  }
]

Get transactions for specific addresses

post
/v1/sync

Gather a list of all MNEE transactions for a batch of addresses

Authorizations
auth_tokenstringRequired
Query parameters
fromintegerOptional
limitintegerOptional

Maximum number of transactions to return per address (defaults to 0, which returns all transactions)

Default: 0
orderstringOptional

Sync Order

Bodystring[]
string[]Optional
Responses
200

Signed transactions

application/json
blkHashstringOptional
blkTimeintegerOptional
heightintegerOptionalExample: 800000
idxintegerOptionalExample: 1
outsinteger[]Optional
rawtxstringOptionalExample: base64 encoded rawtx
receiversstring[]Optional
scorenumberOptionalExample: 800000000000001
sendersstring[]Optional
txidstringOptional
post/v1/sync
POST /v1/sync HTTP/1.1
Host: sandbox-proxy-api.mnee.net
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
[
  {
    "blkHash": "text",
    "blkTime": 1,
    "height": 800000,
    "idx": 1,
    "outs": [
      1
    ],
    "rawtx": "base64 encoded rawtx",
    "receivers": [
      "text"
    ],
    "score": 800000000000001,
    "senders": [
      "text"
    ],
    "txid": "text"
  }
]

Submit a partially-signed transfer transaction

post
/v1/transfer
Authorizations
auth_tokenstringRequired
Body
rawtxstringOptionalExample: base64 string
Responses
200

Signed transaction

application/json
rawtxstringOptionalExample: base64 string
post/v1/transfer
POST /v1/transfer HTTP/1.1
Host: sandbox-proxy-api.mnee.net
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "rawtx": "base64 string"
}
{
  "rawtx": "base64 string"
}

Transfer Mnee tokens

post
/v2/transfer

Validates and transfers mnee transactions. Returns a ticket ID for tracking the transaction.

Authorizations
auth_tokenstringRequired
Body
rawtxstringOptionalExample: base64 string
Responses
200

Transfer submitted successfully. Returns ticket ID for tracking.

text/plain
stringOptional

Ticket ID for tracking the transfer transaction

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
post/v2/transfer
POST /v2/transfer HTTP/1.1
Host: sandbox-proxy-api.mnee.net
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "rawtx": "base64 string"
}
a1b2c3d4-e5f6-7890-abcd-ef1234567890

Get Ticket

get
/v2/ticket

Returns Ticket By Ticket ID

Authorizations
auth_tokenstringRequired
Query parameters
ticketIDstringRequired

Ticket ID

Responses
200

Ticket response

application/json
action_requestedstringOptional
callback_urlstringOptional
createdAtstringOptional
errorsstringOptional
idstringOptional
statusstringOptional
tx_hexstringOptional
tx_idstringOptional
updatedAtstringOptional
get/v2/ticket
GET /v2/ticket?ticketID=text HTTP/1.1
Host: sandbox-proxy-api.mnee.net
Accept: */*

{
  "action_requested": "text",
  "callback_url": "text",
  "createdAt": "text",
  "errors": "text",
  "id": "text",
  "status": "text",
  "tx_hex": "text",
  "tx_id": "text",
  "updatedAt": "text"
}

Retrieve UTXOs for a batch of addresses

post
/v1/utxos
Authorizations
auth_tokenstringRequired
Bodystring[]
string[]Optional
Responses
200

UTXOs

application/json
heightintegerOptional
idxintegerOptional
outpointstringOptional
ownersstring[]Optional
satoshisintegerOptional
scorenumberOptional
scriptstringOptionalExample: base64 string
txidstringOptionalExample: hex string
voutintegerOptional
post/v1/utxos
POST /v1/utxos HTTP/1.1
Host: sandbox-proxy-api.mnee.net
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
[
  {
    "data": {
      "bsv21": {
        "amt": 1,
        "dec": 1,
        "icon": "text",
        "id": "text",
        "op": "text",
        "sym": "text"
      },
      "cosign": {
        "address": "text",
        "cosigner": "text"
      }
    },
    "height": 1,
    "idx": 1,
    "outpoint": "text",
    "owners": [
      "text"
    ],
    "satoshis": 1,
    "score": 1,
    "script": "base64 string",
    "txid": "hex string",
    "vout": 1
  }
]

Get Utxos by addresses

post
/v2/utxos

Returns the array of unspent utxos

Authorizations
auth_tokenstringRequired
Query parameters
pagestringOptional

Default: 1

Default: 1
sizestringOptional

Default: 10

Default: 10
orderstringOptional

Sync Order

Bodystring[]
string[]Optional

Addresses to lookup for utxos

Responses
200

OK

application/json
heightintegerOptional
idxintegerOptional
outpointstringOptional
ownersstring[]Optional
satoshisintegerOptional
scorenumberOptional
scriptstringOptionalExample: base64 string
txidstringOptionalExample: hex string
voutintegerOptional
post/v2/utxos
POST /v2/utxos HTTP/1.1
Host: sandbox-proxy-api.mnee.net
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
[
  {
    "data": {
      "bsv21": {
        "amt": 1,
        "dec": 1,
        "icon": "text",
        "id": "text",
        "op": "text",
        "sym": "text"
      },
      "cosign": {
        "address": "text",
        "cosigner": "text"
      }
    },
    "height": 1,
    "idx": 1,
    "outpoint": "text",
    "owners": [
      "text"
    ],
    "satoshis": 1,
    "score": 1,
    "script": "base64 string",
    "txid": "hex string",
    "vout": 1
  }
]

Fetch balances for given addresses

post
/v2/balance

Accepts a list of addresses and returns their balances.

Authorizations
auth_tokenstringRequired
Bodystring[]
string[]Optional

List of addresses

Responses
200

Balances result

application/json
addressstringOptionalExample: 1A1QNEkLuvAALsmG4Me3iubP8zb5C6jpv5
amtnumberOptionalExample: 30300303
precisednumberOptionalExample: 34.22
post/v2/balance
POST /v2/balance HTTP/1.1
Host: sandbox-proxy-api.mnee.net
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]
[
  {
    "address": "1A1QNEkLuvAALsmG4Me3iubP8zb5C6jpv5",
    "amt": 30300303,
    "precised": 34.22
  }
]

Retrieve transaction

get
/v1/tx/{txid}
Authorizations
auth_tokenstringRequired
Path parameters
txidstringRequired
Responses
200

Transaction data

application/json
rawtxstringOptionalExample: base64 string
get/v1/tx/{txid}
GET /v1/tx/{txid} HTTP/1.1
Host: sandbox-proxy-api.mnee.net
Accept: */*

{
  "rawtx": "base64 string"
}
PreviousBatch Operations
NextMNEE CLI

Last updated