API - Documentation

The web interface is open source! Explore the code for examples of most interfaces.

All request paths are based on the prefix . Request fields should be passed as query parameters for GET requests and JSON form bodies for POST requests.

All requests may also return an error response. The error response has a field error which contains two fields, code and message. code is a numeric error code, and message is a description of the error.

optField is optional.
nullField may be null.
[X,Y)Field value or size must be at least X, less than Y.

/account

Get information about your account. You must specify either password or token.

username [1, 128)

Your account username.

password opt [1, 128)

Your account password.

token opt

The login token returned from /account or /new_account.

Response

id

The internal id of the account.

username

Your account username.

token

The login token returned from /account or /new_account.

balance

The current account balance. Note that money received with the slow flag may not be reflected in the balance yet.

webhook

The details of any transaction relating to this account will be POSTed to this url (formatted as in /transaction).

/change_account

Modify account details.

webhook null

The webhook url.

tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

/delete_in

Delete an in.

id [8, 8]

The id of the in.

tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

/delete_out

Delete an out.

id [8, 8]

The id of the out.

tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

/deposit

Get an address to deposit money in an account from an external source.

tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

Response

address

The litecoin address to send money to.

/deposits

List deposits. If you specify end/start edge you must also specify stamp.

start_edge opt

Show the next deposits after this id

end_edge opt

Show the next deposits before this id

stamp opt

The stamp of the start/end edge.

count [1, 1000)
tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

Response

responses

An array of the inner response object.

Response

Inner response
account

Account ID

stamp

Timestamp of the deposit.

amount

Amount deposited.

address

Destination Litecoin address.

id

Deposit ID

/finance

Response

stamp
data
future

/in

Retrieve details of an in address.

username opt [1, 128)

Your account username.

token opt

The login token returned from /account or /new_account.

id [8, 8]

The id of the in to look up.

Response

dest
id
expire
amount
sender_message
receiver_message
slow

Response

id
expire
amount
sender_message
slow

/ins

start_edge opt [8, 8]
end_edge opt [8, 8]
count [1, 200)
tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

Response

responses

An array of the inner response object.

Response

Inner response
dest
id
expire
amount
sender_message

A suggested transaction description for the sender.

receiver_message

Transaction description for the receiver. Only visible to the receiver.

slow

/new_account

username [1, 128)

Your account username.

password [1, 256)

Response

id
username

Your account username.

token

The login token returned from /account or /new_account.

balance
webhook

/new_in

Create an in address for receiving money.

slow

When money is sent to this address, if false it will be applied to the account balance immediately for a higher fee.

single_use

If true, the address may only receive money once.

expire opt [1

If specified, the address will be unusable after this stamp.

amount opt [1

If specified, all transactions made to this address must have exactly the specified value. Fees are deducted from this amount.

receiver_message 1024]

A personal memo to include in the transaction. Only visible to the receiver.

sender_message 1024]

A suggested personal memo for the sender to include in the transaction.

tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

Response

dest
id
expire
amount
sender_message

A suggested transaction description for the sender.

receiver_message

Transaction description for the receiver. Only visible to the receiver.

slow

/new_out

Create an out address, a way to offer money without a destination address.

amount [1

Amount of money to offer. This is immediately deducted from the offerer's balance. The amount will be returned to the offerer's balance if the out is deleted (less fees).

expire opt

out will be automatically deleted after this date.

receiver_message 1024]

Proposed receiver memo.

sender_message 1024]

Personal memo. Only visible to the sender.

out_password opt [1, 128)

The out can only be accepted if the receiver enters this password.

tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

Response

source
id
amount
expire
sender_message
receiver_message

/out

username opt [1, 128)

Your account username.

token opt

The login token returned from /account or /new_account.

id [8, 8]

Response

source
id
amount
expire
sender_message
receiver_message

Response

id
amount
expire
receiver_message

/outs

start_edge opt [8, 8]
end_edge opt [8, 8]
count [1, 200)
tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

Response

responses

An array of the inner response object.

Response

Inner response
source
id
amount
expire
sender_message
receiver_message

/prices

Retrieve the latest fees.

Response

stamp

When the prices went into effect.

prices

/public_key

Retrieve the public key used to sign transactions.

Response

signature_type
public_key

/rates

Get approximate exchange rates.

Response

stamp
usd
eur
jpy

/receive

source [8, 8]

The address (base 64) of the Out to receive.

slow

If false, apply the transaction to your account as soon as possible for a higher fee.

receiver_message 1024]

A personal memo to include in the transaction. Only visible to the receiver.

source_password opt [1, 128)

If the address has a password, enter it here.

tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

Response

id
dest
amount
stamp
accounting
message
signature_type
sender_signature
receiver_signature

/send

Send money to an in address.

dest [8, 8]

The id of the in address to which to send the money.

amount [1

The amount to send. If the in address specifies an amount, this must exactly match.

sender_message 1024]

A personal memo. Only visible to the sender.

tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

Response

id
source
amount
stamp
sender_message
signature_type
sender_signature
receiver_signature

/set_password

Change an account password.

new_password [1, 256)
tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

Response

Up to date account details.

id
username

Your account username.

token

The login token returned from /account or /new_account.

balance
webhook

/test_webhook

tos
username [1, 128)
token

/tos

Retrieve the hash (id) of the latest terms of service.

Response

id

/transaction

Look up details of a specific transaction.

The signature fields are base64 encoded detached signatures generated with libsodium. For mmv2 signatures, the hash is performed on a spaceless JSON-encoded array of the transaction id, the stamp, the target (source for dest account id), and the amount.

id
tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

Response

The transaction details the receiver sees.

id
source
amount
stamp
sender_message
signature_type
sender_signature
receiver_signature

Response

The transaction details the receiver sees.

id
dest
amount
stamp
accounting
message
signature_type
sender_signature
receiver_signature

/transactions

List transactions. If you don't specify end/start_edge then the most recent transactions will be returned. If you specify end/start edge you must also specify stamp. See /transaction for more field details.

start_edge opt

List the next transactions after this id

end_edge opt

List the previous transactions before this id

stamp opt

Timestamp of the edge transaction

count [1, 1000)

List up to this many transactions

tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

Response

responses

An array of the inner response object.

Response

Inner response

The transaction details the sender sees.

id
source
amount
stamp
sender_message
signature_type
sender_signature
receiver_signature

Response

Inner response

The transaction details the receiver sees.

id
dest
amount
stamp
accounting
message
signature_type
sender_signature
receiver_signature

/withdraw

Remove money from a micromicro account and send to a Litecoin address.

address

The Litecoin address to send the money to.

amount [1

Amount of money to withdraw, in the smallest denomination of Litecoin.

tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

Response

account
address
id
amount
stamp

/withdrawals

List withdrawals. If you don't specify end/start_edge then the most recent withdrawals will be returned. If you specify end/start edge you must also specify stamp.

start_edge opt

List the next withdrawals after this id

end_edge opt

List the previous withdrawals before this id

stamp opt

Timestamp of the edge withdrawal

count [1, 1000)

List up to this many withdrawals

tos

The id of the latest Terms of Service you have agreed to. The request will fail if this is not the latest terms of service.

username [1, 128)

Your account username.

token

The login token returned from /account or /new_account.

Response

responses

An array of the inner response object.

Response

Inner response
account

Account withdrawn from

address

Address money sent to

id

Unique id

amount

Amount withdrawn

stamp

Timestamp (microseconds)