Getting Started

How to get started with the Abyiss API.

API access differs based on your plan

Getting Started with the Abyiss API

Welcome to the Abyiss API! This guide will walk you through the steps to get started and harness the power of our API, enabling you to connect to over 100+ cryptocurrency exchanges and access real-time data for more than 100,000+ cryptocurrencies.

Step 1: Get Your API Keys

To begin using the Abyiss API, you'll need to sign up for an account. Once you have an account, you can find your API Key in the dashboard. API keys are used for authentication in all your API requests. Requests without a valid API key will result in an error.

To learn more about Authentication and API Keys please reference the API Keys - Authentication section under API Architecture.

Step 2: Explore Available Endpoints

Our API Endpoints are broken up into a few categories:

Crypto API: Access real-time and historical data for over 100,000+ cryptocurrencies across 100+ centralized exchanges. Retrieve information such as market prices, trading volumes, and more.
Blockchain API: Interact with blockchain networks and retrieve data related to decentralized exchanges, blocks, tokens, liquidity pools, and more. Leverage this API category to build applications that require direct access to blockchain data.
Alerts API: Set up custom alerts and notifications for specific events or market conditions. Stay informed about price changes, volume fluctuations, or other criteria that are crucial to your cryptocurrency trading or analysis strategies.

You will need an API Key to access all of our endpoints.

Step 3: Make Your First Request

To make your first request, just ping our API: https://api.abyiss.com/ping. This will return "Hello from the Abyiss". All requests return JSON-encoded responses.

Ping Abyiss

GET https://api.abyiss.com/ping

Returns "Hello from the Abyiss"

{
    "ping": "Hello from the Abyiss"
}

Example URL

Response Object

{
    "ping": "Hello from the Abyiss"
}

Step 4: Copy & Paste Code

Take a look at how you might call our API using the following programing languages.

Feel free to copy and paste this code into your own development environment and try it for yourself.

from Abyiss import Abyiss

apiKey = "YOUR API KEY"" 
client = Abyiss.Client(apiKey) 


exchanges = client.getExchanges()

exchangeDetails = client.getExchangeDetails("coinbasepro")

exchangeStatus = client.getExchangeStatus("coinbasepro")

exchangeMarkets = client.getExchangeMarkets("coinbasepro")

exchangeMarketDetails = client.getMarketDetails("coinbasepro", "BTC-USDT")

aggregates = client.aggregates("coinbasepro", "BTC-USDT", "1h", '300')

trades = client.trades("coinbasepro", "BTC-USDT", '300')

quotes = client.quotes("coinbasepro", "BTC-USDT")

orderbook = client.orderBook("coinbasepro", "BTC-USDT")

import { Abyiss } from 'abyiss'

const A = new Abyiss('YOUR API KEY')

async function showExchanges () {
  console.log(await A.exchanges())
}

async function aggregate () {
    console.log(await A.aggregates('coinbasepro', 'btc-usd', '1m', {limit: 2})) 
}

showExchanges()
aggregate()

curl https://api.abyiss.com/ping

Step 5: Client Libraries

To simplify your integration process, we provide Client Libraries in various programming languages. You can find our client libraries on GitHub. These libraries offer convenient methods and examples to help you interact with our API in your preferred programming language. Feel free to copy and paste the code examples into your development environment and try them out.

Currently, we support client libraries in the following programming languages:

For more information about our client libraries, please refer to the GitHub documentation.

Need support?

If you need any additional support please contact us on our website Abyiss.com or send us an email at support@abyiss.com. We are here to help.

PreviousWelcome NextReading Documentation

Last updated 1 year ago