Coinmate API Examples

Complete API client implementations for the Coinmate.io cryptocurrency exchange in Java, TypeScript, Python, and PHP.

All four implementations provide:

✅ Complete API Coverage - All 55+ Coinmate API endpoints
✅ Type Safety - Full type checking (compile-time for Java/TS, runtime hints for Python/PHP)
✅ HMAC-SHA256 Authentication - Automatic signature generation
✅ Production Ready - Error handling, proper decimal precision
✅ Well Documented - Examples and detailed documentation

Choose Your Language

Language	Best For	Async	Precision	Documentation
Java	Enterprise, trading bots	Blocking	BigDecimal	📖 Java Docs
TypeScript	Web apps, Node.js services	Non-blocking	number	📖 TS Docs
Python	Scripts, data analysis	Non-blocking	Decimal	📖 Python Docs
PHP	Web backends, APIs	Blocking	string	📖 PHP Docs

Quick Start

All four implementations share the same .env file for credentials!

1. Setup Credentials (Once)

# Copy the example file
cp .env.example .env

# Edit .env and add your Coinmate API credentials
# COINMATE_CLIENT_ID=your_client_id
# COINMATE_PUBLIC_KEY=your_public_key
# COINMATE_PRIVATE_KEY=your_private_key

Get your credentials from Coinmate Account Settings.

2. Run Your Preferred Implementation

Java

mvn exec:java \
  -Dexec.mainClass="org.example.Main"

TypeScript

cd typescript
npm install
npm start

Python

cd python
pip install -r requirements.txt
python -m src.main

PHP

cd php
composer install
composer start

Code Examples

Get Ticker (All Languages)

Java

TypeScript

Python

CoinmateTypedClient client =
  new CoinmateTypedClient(config);

CoinmateResponse<Ticker> response =
  client.getTicker("BTC_EUR");

if (response.isSuccess()) {
  Ticker ticker = response.getData();
  System.out.println(ticker.getLast());
}

const client = new CoinmateClient(config);

const response =
  await client.getTicker('BTC_EUR');

if (!response.error) {
  const ticker = response.data;
  console.log(ticker.last);
}

async with CoinmateClient(config) as client:
  response = await client.get_ticker('BTC_EUR')

  if not response.error:
    ticker = response.data
    print(ticker.last)

Place Buy Order (All Languages)

Java

TypeScript

Python

CoinmateResponse<OrderResult> order =
  client.buyLimit(
    "BTC_EUR",
    "0.001",
    "50000"
  );

if (order.isSuccess()) {
  System.out.println(
    order.getData().getOrderId()
  );
}

const order = await client.buyLimit({
  currencyPair: 'BTC_EUR',
  amount: '0.001',
  price: '50000'
});

if (!order.error) {
  console.log(order.data.orderId);
}

order = await client.buy_limit(
  currency_pair='BTC_EUR',
  amount='0.001',
  price='50000'
)

if not order.error:
  print(order.data.order_id)

Supported Endpoints

All four implementations support the same complete set of endpoints:

Public Endpoints (No Authentication)

🪙 Currencies and trading pairs
📊 Order book and ticker data
📈 Recent transactions
⏰ Server time

Account Management (Authentication Required)

💰 Account balances
💵 Trading fees
📜 Transaction history
📊 Trade history
🔄 Transfer history

Trading (Authentication Required)

📈 Buy/Sell limit orders
⚡ Buy/Sell instant (market) orders
🔄 Replace orders
❌ Cancel orders
📋 Order history

Deposits & Withdrawals (Authentication Required)

₿ Bitcoin (BTC) - including Lightning Network
Ξ Ethereum (ETH)
Ł Litecoin (LTC)
✕ Ripple (XRP)
₳ Cardano (ADA)
◎ Solana (SOL)
💳 Bank wire withdrawals

Total: 55+ endpoints fully implemented

Project Structure

coinmateApiExamples/
├── .env                    # Shared credentials (all languages)
├── .env.example            # Template
├── LICENSE                 # MIT License
├── README.md              # This file (language-neutral)
│
├── java/                   # Java implementation
│   ├── main/java/org/example/coinmate/
│   │   ├── auth/          # HMAC-SHA256 authentication
│   │   ├── client/        # API clients
│   │   ├── config/        # Configuration
│   │   └── model/         # Type-safe models
│   ├── README.md          # Java documentation
│   ├── API_METHODS.md     # Complete method reference
│   └── TYPED_MODELS.md    # Typed models guide
│
├── typescript/             # TypeScript/Node.js implementation
│   ├── src/
│   │   ├── auth/          # HMAC-SHA256 authentication
│   │   ├── client/        # API clients
│   │   ├── types/         # TypeScript type definitions
│   │   └── main.ts        # Example application
│   └── README.md          # TypeScript documentation
│
├── python/                 # Python implementation
│   ├── src/
│   │   ├── auth/          # HMAC-SHA256 authentication
│   │   ├── client/        # API clients
│   │   ├── types/         # Python type definitions (dataclasses)
│   │   └── main.py        # Example application
│   └── README.md          # Python documentation
│
└── php/                    # PHP implementation
    ├── src/
    │   ├── Auth/          # HMAC-SHA256 authentication
    │   ├── Client/        # API clients
    │   ├── Types/         # PHP type definitions (readonly classes)
    │   └── main.php       # Example application
    └── README.md          # PHP documentation

Authentication

All implementations use the same HMAC-SHA256 authentication mechanism:

Nonce: Unix timestamp in milliseconds (must increase with each request)
Message: Concatenate nonce + clientId + publicKey
Signature: HMAC-SHA256 hash of message using private key
Format: Convert signature to uppercase hexadecimal string

Authentication is handled automatically by each client.

Type Safety Comparison

Feature	Java	TypeScript	Python	PHP
Compile-time checks	✅ Yes	✅ Yes	⚠️ No (runtime hints)	⚠️ No (runtime)
IDE auto-completion	✅ Full	✅ Full	✅ Full	✅ Full
Decimal precision	BigDecimal	number (float)	Decimal	string
Refactoring support	✅ Full	✅ Full	⚠️ Limited	⚠️ Limited
Null safety	✅ Yes	✅ Yes	⚠️ Optional	⚠️ Optional

Language-Specific Features

Java

Two API styles: JsonObject (flexible) and Typed Models (recommended)
BigDecimal for precise financial calculations
Builder pattern for configuration
Try-with-resources for automatic cleanup
Maven for dependency management

See Java Documentation

TypeScript

Full TypeScript type definitions
Async/await with Promises
Zero external dependencies (only axios and dotenv)
npm scripts for development
Works in Node.js

See TypeScript Documentation

Python

Type hints with dataclasses
Async/await with asyncio and aiohttp
Decimal type for financial precision
Context managers for cleanup
pip for dependency management
Python 3.11+ required

See Python Documentation

PHP

Readonly classes for immutable types (PHP 8.2+)
Guzzle HTTP client for requests
phpdotenv for environment configuration
Composer for dependency management
PSR-4 autoloading

See PHP Documentation

Security Best Practices

🔒 Never commit your API keys!

The .env file is in .gitignore and won't be committed
Use environment variables or the .env file for credentials
Consider using read-only API keys for non-trading operations
Rotate your keys regularly
Use different keys for development and production

Testing Without Credentials

All four implementations can run without credentials and will test only public endpoints:

# Java
mvn exec:java -Dexec.mainClass="org.example.Main"

# TypeScript
cd typescript && npm start

# Python
cd python && python -m src.main

# PHP
cd php && composer start

Error Handling

All implementations follow the same error handling pattern:

Network errors: Caught as exceptions/errors at the call site
API errors: Returned in the response object with error: true and errorMessage
Check before use: Always check isSuccess() (Java) or !error (TS/Python) before accessing data

Building for Production

Java

mvn clean package
java -jar target/coinmate-api-example-1.0-SNAPSHOT.jar

TypeScript

cd typescript
npm run build
node dist/main.js

Python

cd python
python -m src.main  # Or deploy with your preferred method

PHP

cd php
composer install --no-dev
php src/main.php

Contributing

This is an example project demonstrating Coinmate API integration in multiple languages. Feel free to:

Fork and extend for your needs
Report issues
Suggest improvements
Add more language implementations

License

MIT License - See LICENSE for details.

Resources

Need Help?

Java: See java/README.md
TypeScript: See typescript/README.md
Python: See python/README.md
PHP: See php/README.md
API Methods: See java/API_METHODS.md
Typed Models (Java): See java/TYPED_MODELS.md

Made with ❤️ for the Coinmate.io community

Name		Name	Last commit message	Last commit date
Latest commit History 2 Commits
java		java
php		php
python		python
resources		resources
typescript		typescript
.env.example		.env.example
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
pom.xml		pom.xml

License

coinmate-io/coinmate-api-examples

Folders and files

Latest commit

History

Repository files navigation

Coinmate API Examples

Choose Your Language

Quick Start

1. Setup Credentials (Once)

2. Run Your Preferred Implementation

Code Examples

Get Ticker (All Languages)

Place Buy Order (All Languages)

Supported Endpoints

Public Endpoints (No Authentication)

Account Management (Authentication Required)

Trading (Authentication Required)

Deposits & Withdrawals (Authentication Required)

Project Structure

Authentication

Type Safety Comparison

Language-Specific Features

Java

TypeScript

Python

PHP

Security Best Practices

Testing Without Credentials

Error Handling

Building for Production

Java

TypeScript

Python

PHP

Contributing

License

Resources

Need Help?

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages