Introduction

Welcome to the Monday API documentation. This comprehensive guide will help you integrate with Monday trading platform and access market data, trading functionality, and account management features.

What is Monday API?

The Monday API is a RESTful interface that allows developers to:

• Access real-time and historical market data

• Manage trading accounts and positions

• Execute orders and view order history

• Track liquidity positions

• Monitor account transactions and balances

• Retrieve funding rate and trading history

Key Features

Real-time Market Data

• Server Time: Get synchronized server time

• Instruments Info: Retrieve trading instrument specifications

• Kline Data: Access candlestick chart data for technical analysis

• Orderbook: View real-time order book depth

• Tickers: Get 24-hour price statistics

• Funding Rate History: Track funding rate changes over time

Account Management

• Account Balance: Check account balances and assets

• Transaction History: View deposit and withdrawal records

• Position Management: Monitor open positions and margin levels

Trading Operations

• Order Management: Place, view, and manage orders

• Order History: Access historical order data

• Trade Execution: View detailed trade execution information

• Margin Transfers: Add or remove margin from positions

Liquidity Provision

• Liquidity Positions: View active liquidity positions

• Liquidity History: Track liquidity addition and removal operations

Getting Started

1. Register for API Access

To use the Monday API, you need to:

1. Create an account on the Monday platform

2. Contact us to obtain API credentials:

   • API Key: Your public API key

   • Secret Key: Your private secret key (keep this secure!)

   • Passphrase: Required for API authentication

3. Secure your API credentials

Quick Start with Public API Key: For testing purposes, you can use the public API key provided in the Quick Start Guide:

• API Key: ed1190b7c4aed9a515015425e3d24b3b

• Secret Key: 373b3c3f8233c4ef13d7c5765b9cfe78

• Passphrase: 6fbb7707c86de67e

2. Read the Quick Start Guide

Before diving into the API, we recommend reading the Quick Start Guide which covers:

• Authentication setup

• Generating signatures

• Making your first API call

• Error handling

• Best practices

3. Explore the API

• Review the API Overview for a complete list of available endpoints

• Check Error Codes for error handling

• Reference Enums for available values and types

Base URL

All API requests should be made to:

https://api.monday.trade

API endpoints use the path prefix /v4/public/mm/, so the full URL format is:

https://api.monday.trade/v4/public/mm/{endpoint}

Authentication

All API endpoints require authentication using:

• API Key (X-ACCESS-KEY): Your public API key

• Secret Key: Your private secret key (used for signature generation)

• Passphrase (X-ACCESS-PASSPHRASE): Your API passphrase

• Signature (X-ACCESS-SIGN): HMAC-SHA256 signature with Base64 encoding

• Timestamp (X-ACCESS-TIMESTAMP): Request timestamp in ISO 8601 UTC format

The signature is generated using the format: timestamp + method + request_path + body

Detailed authentication instructions and code examples can be found in the Quick Start Guide.

Response Format

All API responses follow a standard format:

{
    "code": 200,
    "msg": "",
    "data": {},
    "requestId": "bbf4fa1a-0f41-449f-8d9c-44fdceae0bf7"
}

Success Response

{
    "code": 200,
    "msg": "",
    "data": {
        // Response data here
    },
    "requestId": "bbf4fa1a-0f41-449f-8d9c-44fdceae0bf7"
}

Error Response

{
    "code": 400,
    "msg": "Error message here",
    "data": {},
    "requestId": "bbf4fa1a-0f41-449f-8d9c-44fdceae0bf7"
}

Rate Limits

• Rate Limit: 120 requests per minute per API key

• Rate limit headers: Monitor your rate limit status via response headers

• Best Practice: Implement exponential backoff for retry logic

Error Handling

HTTP Status Codes

• 200: Success

• 400: Bad Request - Invalid parameters

• 401: Unauthorized - Invalid API credentials

• 403: Forbidden - Insufficient permissions

• 429: Too Many Requests - Rate limit exceeded

• 500: Internal Server Error

For detailed error codes and handling strategies, refer to Error Codes Documentation.

Data Types

String

Most text fields (symbols, addresses, etc.) are returned as strings.

Number

Numeric values can be integers or decimals. Large numbers may be returned as strings to prevent precision loss.

Timestamp

Timestamps are returned in milliseconds since Unix epoch.

Address

Blockchain addresses (contract addresses, wallet addresses) are returned as hexadecimal strings.

Security Best Practices

1. Keep API Credentials Secure

   • Never share your API Key or Secret Key

   • Don't commit API credentials to version control

   • Rotate API keys regularly

2. Use HTTPS Only

   • All API requests must use HTTPS

   • Never make API calls over HTTP

3. Implement Proper Error Handling

   • Handle all error responses gracefully

   • Implement retry logic with exponential backoff

   • Log errors for debugging

4. Monitor Rate Limits

   • Track your request rate

   • Implement rate limiting on your side

   • Avoid unnecessary API calls

5. Validate Inputs

   • Validate all parameters before making requests

   • Check data types and ranges

   • Use appropriate enums from the documentation

Code Examples

The API documentation includes code examples in multiple languages:

• cURL: For command-line testing

• JavaScript (Fetch): For web applications

• Python (requests): For Python applications

You can find language-specific examples in each API endpoint documentation.

Support and Resources

Documentation

• Quick Start Guide - Get started quickly

• API Overview - Complete endpoint reference

• Error Codes - Error handling guide

• Enums - Available values and types

Getting Help

For API support and questions, please contact:

• Email: [support email]

• Documentation: [documentation URL]

• Community: [community forum URL]

Version Information

• Current Version: v4

• Base URL: https://api.monday.trade/v4/public

• API Format: RESTful

• Data Format: JSON

Next Steps

1. Read the Quick Start Guide

2. Browse the API Overview

3. Explore specific endpoint documentation

4. Implement error handling

5. Start building your integration

Changelog

Version 5

• Updated response format

• Added blockInfo to responses

• Improved error handling

• Enhanced documentation

---

Happy coding with Monday API!