Getting started overview

This guide outlines the essential steps to begin using Coinigy, focusing on account creation, API key generation, and executing a foundational API request. Coinigy provides a unified interface for managing cryptocurrency portfolios and executing trades across various exchanges, offering programmatic access via its REST API for developers and automated trading strategies. The platform requires a paid subscription for full access, though a 30-day free trial is available for the Pro plan to explore features, including API functionality.

The process generally involves:

  1. Account Creation: Registering on the Coinigy website.
  2. Subscription: Selecting and activating a paid plan (or trial).
  3. API Key Generation: Obtaining necessary credentials from your account settings.
  4. First Request: Making an authenticated call to the Coinigy API.

This page assumes familiarity with basic API concepts, such as HTTP requests and JSON data formats. For a deeper understanding of RESTful API principles, refer to the Mozilla Developer Network's REST API guide.

Quick Reference Steps

Step What to Do Where
1. Sign Up Create a Coinigy account. Coinigy homepage
2. Subscribe Choose a plan or start a 30-day Pro trial. Coinigy pricing page
3. Generate API Key Navigate to API settings and create new keys. Coinigy Dashboard > Account > API
4. Make Request Use your API key to call an endpoint (e.g., /api/v1/balances). Your preferred development environment
5. Explore Docs Review available endpoints and data models. Coinigy API documentation

Create an account and get keys

To access the Coinigy platform and its API, a registered account with an active subscription or trial is required. Coinigy does not offer a free tier beyond the 30-day Pro trial, as detailed on the Coinigy plans page.

Account Registration

  1. Navigate to the Coinigy website.
  2. Click on the "Sign Up" or "Get Started" button.
  3. Provide the requested information, including email address and a strong password.
  4. Complete any necessary email verification steps.

Subscription Activation

After creating an account, you will be prompted to select a plan. To utilize the API, you must either:

  • Start the 30-day free trial of the Pro Plan.
  • Subscribe to a paid plan (Pro or higher), which includes API access.

Pricing information, including annual and monthly billing options, is available on the Coinigy pricing page.

API Key Generation

API keys are essential for authenticating your requests to the Coinigy API. These keys link your programmatic actions to your Coinigy account and associated permissions. It is crucial to handle API keys securely, treating them like passwords.

  1. Log in to your Coinigy account.
  2. Navigate to your Account Settings. The exact path may vary but typically involves clicking on your profile icon or username and selecting "Settings" or "API".
  3. Look for a section labeled "API Keys" or "Developer Settings."
  4. Click "Generate New API Key" or a similar option.
  5. You will typically receive two components: an API Key (sometimes called a Public Key or Client ID) and an API Secret.
  6. Important: Copy both the API Key and API Secret immediately. The API Secret is often displayed only once upon generation and cannot be retrieved later. If lost, you will need to generate a new pair.
  7. Store these keys securely. Avoid hardcoding them directly into your application code, especially if the code is publicly accessible. Environment variables or a secure configuration management system are preferred methods for handling sensitive credentials.

Your first request

After obtaining your API Key and Secret, you can make your first authenticated request to the Coinigy API. Coinigy's API is a RESTful interface, meaning it uses standard HTTP methods (GET, POST, etc.) to interact with resources and returns data primarily in JSON format. The base URL for the Coinigy API is generally https://api.coinigy.com/api/v1.

For this example, we will retrieve your account balances, a common first step to confirm API connectivity and authentication. This requires a GET request to the /balances endpoint. Coinigy typically uses custom HTTP headers for authentication.

Authentication Headers

Requests to the Coinigy API require specific headers:

  • X-API-KEY: Your generated API Key.
  • X-API-SECRET: Your generated API Secret.
  • Content-Type: application/json (for POST/PUT requests, though good practice to include for GET).

Example Request (using curl)

Replace YOUR_API_KEY and YOUR_API_SECRET with your actual credentials.

curl -X GET \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "X-API-SECRET: YOUR_API_SECRET" \
  -H "Content-Type: application/json" \
  "https://api.coinigy.com/api/v1/balances"

Expected Response

A successful request will return a JSON object containing your balances across connected exchanges. The structure will resemble:

{
  "data": [
    {
      "balance_id": "string",
      "exchange": "string",
      "currency": "string",
      "balance_available": "string",
      "balance_hold": "string",
      "last_updated": "string"
    }
  ],
  "pagination": {
    "current_page": "integer",
    "total_pages": "integer",
    "total_count": "integer"
  }
}

If you receive an error, proceed to the Troubleshooting the first call section.

Using a Programming Language (Python Example)

Here's how you might make the same request using Python with the requests library:

import requests
import os

API_KEY = os.environ.get("COINIGY_API_KEY")
API_SECRET = os.environ.get("COINIGY_API_SECRET")
BASE_URL = "https://api.coinigy.com/api/v1"

headers = {
    "X-API-KEY": API_KEY,
    "X-API-SECRET": API_SECRET,
    "Content-Type": "application/json"
}

try:
    response = requests.get(f"{BASE_URL}/balances", headers=headers)
    response.raise_for_status()  # Raise an exception for HTTP errors (4xx or 5xx)
    data = response.json()
    print("Successfully retrieved balances:")
    print(data)
except requests.exceptions.HTTPError as e:
    print(f"HTTP error occurred: {e}")
    print(f"Response content: {response.text}")
except requests.exceptions.RequestException as e:
    print(f"An error occurred during the request: {e}")

Remember to set your COINIGY_API_KEY and COINIGY_API_SECRET environment variables before running this script for secure credential handling.

Common next steps

Once you have successfully made your first API call, consider these next steps to further integrate with Coinigy:

  • Explore API Documentation: Thoroughly review the official Coinigy API documentation to understand all available endpoints, request parameters, and response structures. This will be essential for building more complex applications.
  • Connect Exchanges: Use the Coinigy web interface to connect your various cryptocurrency exchange accounts. This is a prerequisite for using Coinigy's unified trading and portfolio management features, both through the UI and the API.
  • Implement Trading Operations: Familiarize yourself with endpoints for placing, canceling, and checking the status of orders. This is fundamental for building automated trading bots or custom trading interfaces.
  • Portfolio Tracking: Utilize endpoints that provide historical data, trade history, and detailed balance information to build comprehensive portfolio tracking and reporting tools.
  • Error Handling: Implement robust error handling in your code to gracefully manage API rate limits, authentication failures, and other potential issues.
  • Webhooks (if available): Check if Coinigy offers webhooks for real-time notifications on events like order fills or balance changes. Webhooks can significantly reduce the need for constant polling. For a general understanding of webhooks, consult the Stripe webhooks documentation.
  • Rate Limiting: Understand and respect Coinigy's API rate limits to avoid temporary bans or service interruptions. Details on rate limits are typically found in the API documentation.

Troubleshooting the first call

Encountering issues during your first API call is common. Here are some troubleshooting steps:

  • Verify API Keys: Double-check that your API Key and Secret are copied precisely. Even a single character mismatch can cause authentication failures. Remember, the Secret is often only shown once. If unsure, generate a new pair.
  • Check Headers: Ensure that the X-API-KEY and X-API-SECRET headers are correctly set in your request. Case sensitivity matters for header names and values.
  • Subscription Status: Confirm that your Coinigy account has an active paid subscription or is within the 30-day Pro trial period. API access is not available on expired trials or without a subscription.
  • Endpoint URL: Verify that the base URL and endpoint path are correct (e.g., https://api.coinigy.com/api/v1/balances).
  • HTTP Status Codes: Pay attention to the HTTP status code returned in the API response. Common codes include:
    • 200 OK: Success.
    • 400 Bad Request: Your request was malformed (e.g., incorrect parameters).
    • 401 Unauthorized: Authentication failed (invalid API key/secret).
    • 403 Forbidden: You don't have permission to access the resource (e.g., trying to access an endpoint not covered by your plan, or IP restriction).
    • 429 Too Many Requests: You have hit a rate limit. Implement a backoff strategy.
    • 5xx Server Error: An issue on Coinigy's server side.
  • Error Messages: Read the error message in the JSON response body carefully. Coinigy's API often provides specific details about what went wrong.
  • Network Connectivity: Ensure your development environment has stable internet access and no firewalls are blocking outbound requests to api.coinigy.com.
  • Documentation Review: Refer to the specific endpoint documentation on the Coinigy API documentation for any specific requirements or nuances.
  • Contact Support: If you've exhausted all troubleshooting steps, reach out to Coinigy's support team with your request details, error messages, and steps taken.