001k API/v1 Documentation¶
Welcome to the 001k API/v1 Documentation. This API provides a secure and reliable way to interact with our platform programmatically, allowing you to integrate our services into your applications.
Overview¶
Our API follows RESTful principles and uses HMAC-SHA256 authentication to ensure secure communication. All requests and responses are in JSON format.
Base URL:
Authentication¶
The API uses a custom authentication scheme based on HMAC-SHA256 signatures. See the Authentication section for details on how to authenticate your requests.
Rate Limiting¶
Each endpoint has its own rate limit, typically ranging from 30 to 600 requests per minute. The rate limit is specified in each endpoint's documentation.
Common Features¶
- Custom IDs: Most operations support a
custom_idparameter that allows you to assign your own unique identifier to track operations. - Callbacks: Many operations support callback URLs that will be called when the operation's status changes.
- Idempotency: Operations are designed to be idempotent when using custom IDs, meaning that sending the same request multiple times will not result in duplicate operations.
Available Endpoints¶
The API provides the following main categories of endpoints:
- Balances - View your account balances
- Currencies - Get information about available currencies
- Deposits - Generate deposit addresses and track deposits
- Withdrawals - Create and track withdrawal requests
- Internal Transfers - Transfer funds between users
- Swaps - Exchange one currency for another
- Limit Orders - Place and manage limit orders
- AML Checks - Perform anti-money laundering checks on addresses
Implementation Examples¶
To help you get started, we provide implementation examples in several programming languages:
Server Status¶
You can check the API server status using the /status endpoint, which does not require authentication.
Response:
The timestamp is in milliseconds since the Unix epoch.