Mixero API Documentation

COINJOIN

Overview

• All requests require a valid API key, provided as an api_key parameter.
• The API key is validated on our side.

Base URL

https://api.mixero.io/coinjoin

Endpoints

1. Generating an API Key (generate_api_key)

Endpoint: ?generate_api_key

Method: GET

Usage: https://api.mixero.io/coinjoin?generate_api_key

Parameters: None required.

Response:

• On success: JSON including the new API key under the key api_key and 'success' => true.
• On error: JSON with an error message, e.g., {'success' => false, 'error' => 'Failed to generate API key'}.

2. Create Order (create_order)

Endpoint: ?create_order

Method: GET

Usage: https://api.mixero.io/coinjoin?create_order&api_key=your_api_key&other_parameters...

Parameters:

• api_key (string): API key for authentication.
• percentage_fees (float): Fee percentage, between 0.7 and 4.7.
• delay (int): Delay in hours, between 0 and 168.
• destination_address_1 ... destination_address_5 (string): Destination addresses.
• percentage_1 ... percentage_5 (float): Percentages corresponding to addresses, totaling 100%.

Response:

• On success: JSON including order_id, deposit_address, destination_addresses, percentage_fees, percentages, delay as a future timestamp indicating the exact time when the order will be processed, and success.
• On error: JSON with an error message.

3. Lookup Order (lookup)

Endpoint: ?lookup

Method: GET

Usage: https://api.mixero.io/coinjoin?lookup&order_id=order_id_value&api_key=your_api_key

Parameters:

• api_key (string): API key for authentication.
• order_id (string): Order ID for retrieval.

Response:

• On success: JSON including the details of the order.
• On error: JSON with an error message.

4. Letter of Guarantee (letter)

Endpoint: ?letter

Method: GET

Usage: https://api.mixero.io/coinjoin?letter&order_id=order_id_value&api_key=your_api_key

Parameters:

• api_key (string): API key for authentication.
• order_id (string): Order ID to get the letter of guarantee.

Response:

• On success: JSON or text including the letter of guarantee.
• On error: JSON with an error message.

Typical Usage Flow

• Create an Order: Send a request to ?create_order with all required parameters.
• Lookup an Order: Use ?lookup with the order_id to get details about the order.
• Get a Letter of Guarantee: Request a letter of guarantee for a specific order via ?letter.

Error Handling

• If the API key is invalid, an error is returned.
• If required parameters are missing or incorrect, a specific error is returned.

Limitation

Our API enforces a rate limit to ensure optimal performance and fair usage for all users. Each API key is allowed a maximum of 150 requests per day. If you exceed this limit, you will receive an error message indicating that the rate limit has been exceeded.

ADVANCED

Overview

• All requests require a valid API key, provided as an api_key parameter.
• The API key is validated on our side.

Base URL

https://api.mixero.io/advanced

Endpoints

1. Generating an API Key (generate_api_key)

Endpoint: ?generate_api_key

Method: GET

Usage: https://api.mixero.io/advanced?generate_api_key

Parameters: None required.

Response:

• On success: JSON including the new API key under the key api_key and 'success' => true.
• On error: JSON with an error message, e.g., {'success' => false, 'error' => 'Failed to generate API key'}.

2. Create Order (create_order)

Endpoint: ?create_order

Method: GET

Usage: https://api.mixero.io/advanced?create_order&api_key=your_api_key&other_parameters...

Parameters:

• api_key (string): API key for authentication.
• percentage_fees (float): Fee percentage, between 1.9 and 4.7.
• destination_address (string): Destination addresses.

Response:

• On success: JSON including order_id, deposit_address, destination_address, percentage_fees and success.
• On error: JSON with an error message.

3. Lookup Order (lookup)

Endpoint: ?lookup

Method: GET

Usage: https://api.mixero.io/advanced?lookup&order_id=order_id_value&api_key=your_api_key

Parameters:

• api_key (string): API key for authentication.
• order_id (string): Order ID for retrieval.

Response:

• On success: JSON including the details of the order.
• On error: JSON with an error message.

4. Letter of Guarantee (letter)

Endpoint: ?letter

Method: GET

Usage: https://api.mixero.io/advanced?letter&order_id=order_id_value&api_key=your_api_key

Parameters:

• api_key (string): API key for authentication.
• order_id (string): Order ID to get the letter of guarantee.

Response:

• On success: JSON or text including the letter of guarantee.
• On error: JSON with an error message.

Typical Usage Flow

• Create an Order: Send a request to ?create_order with all required parameters.
• Lookup an Order: Use ?lookup with the order_id to get details about the order.
• Get a Letter of Guarantee: Request a letter of guarantee for a specific order via ?letter.

Error Handling

• If the API key is invalid, an error is returned.
• If required parameters are missing or incorrect, a specific error is returned.

Limitation

Our API enforces a rate limit to ensure optimal performance and fair usage for all users. Each API key is allowed a maximum of 150 requests per day. If you exceed this limit, you will receive an error message indicating that the rate limit has been exceeded.