The new credit-based system will allow developers to have greater flexibility with how they access everything Shrimpy has to offer.

Developers can buy credits at a rate of 100 credits for every 1 US Dollar. These credits can be used to access any feature in the developer API. That means there are no specialized credits for different data types, endpoints, or usage. Everything uses a single credit system.

Automated Credit Refill

We highly recommend leveraging the automated credit refill system. This feature allows developers to not worry about running out of credits, especially for developers that require 100% up-time for their service. The automated credit refill feature will purchase additional credits when your account balance gets low.

For example, if you make an initial purchase of $50 (5,000 credits), you can set an automated refill at $10 (1,000 credits). That way, as soon as your credits drop below 1,000, Shrimpy will automatically rebuy 5,000 more credits for your account.

It’s the easiest way to stay on top of your credit balance.

Pricing Breakdown

There are a number of major categories that should be examined when looking at the new pricing breakdown. The most important pricing changes you should understand before using the new pricing system include the historical market data, live market data, and user management.

These are the three most likely areas where you will incur charges, so we recommend fully understanding each of these categories before taking the dive into the new pricing system.

Historical Market Data (REST API)

These endpoints are used to access historical tick-by-tick trade data, order book snapshots, and candlesticks. Each of these endpoints is priced differently, so we recommend carefully reading this section to ensure you understand how the different data points are priced before sending requests.

Historical Trades (3 credits / 1,000 trades)

Tick-by-tick trade data can be accessed through the “get historical trades” endpoint. Shrimpy charges for every single trade that is returned in a response. That means if Shrimpy returns 100 trades in a single response, that will cost 0.3 credits.

Historical Order books (20 credits / 1,000 snapshots)

Order book snapshots can be retrieved from Shrimpy through the “get historical order books” endpoint. Shrimpy will charge for each snapshot that is returned in the response. For example, if Shrimpy returns 100 order book snapshots in a single response, that will cost 2 credits.

Historical Candlesticks (50 credits / 1,000 snapshots)

Candlesticks can be retrieved from Shrimpy through the “get historical candles” endpoint. Shrimpy will charge for each candlestick that is returned in the response. For example, if Shrimpy returns 100 candlesticks in a single response, that will cost 5 credits.

Note: Please notice that when we refer to a “candlestick” we are referring to a single candlestick, not a group of candlesticks. A single candlestick has 1 open price, 1 high price, 1 low price, 1 close price, and 1 volume amount.

Additional Info: Shrimpy supports both a historical candlestick endpoint and a live candlestick endpoint. The live candlestick endpoint is significantly cheaper, but only gives access to the last 1,000 candles.

Live Market Data (REST API)

The live REST API endpoints give developers a low-cost way to access real-time market data for any exchange supported by Shrimpy. At this time, all of these endpoints are priced the same.

Ticker (1 credit / 1,000 API calls)

A live price ticker can be accessed through the “get ticker” endpoint. Shrimpy charges a flat 1 credit / 1,000 API calls no matter how much data is returned for this request.

Order book (1 credit / 1,000 API calls)

A live order book can be accessed through the “get order books” endpoint. Shrimpy charges a flat 1 credit / 1,000 API calls no matter how much data is returned for this request.

Candlesticks (1 credit / 1,000 API calls)

Live candlesticks can be accessed through the “get candles” endpoint. Shrimpy charges a flat 1 credit / 1,000 API calls no matter how much data is returned for this request.

List Exchanges (1 credit / 1,000 API calls)

A list of supported exchanges can be accessed through the “get supported exchanges” endpoint. Shrimpy charges a flat 1 credit / 1,000 API calls no matter how much data is returned for this request.

List Assets (1 credit / 1,000 API calls)

A list of supported assets for each exchange can be accessed through the “get exchange assets” endpoint. Shrimpy charges a flat 1 credit / 1,000 API calls no matter how much data is returned for this request.

List Trading Pairs (1 credit / 1,000 API calls)

A list of supported trading pairs for each exchange can be accessed through the “get trading pairs” endpoint. Shrimpy charges a flat 1 credit / 1,000 API calls no matter how much data is returned for this request.

User Management (0.1 credits / user / hour)

The user management system will charge based on the number of users you are managing. Each user costs 0.1 credits / hour. That means if you have 10 users, Shrimpy will charge you 1 credit per hour.

Notice: Developers can delete a user at any time using the “Remove User” endpoint. Once a user is removed, you will no longer be able to take any action for that user. Shrimpy will not charge for any removed user.

User Management Endpoints (No Additional Cost)

Since users have a cost of 0.1 credits / hour, we do not have any additional cost for linking exchange accounts, retrieving balance data, executing trades, rebalancing, executing smart order routing trades, or any other action that could be taken on a user. All of these actions are free of cost.

speed.png

Live Market Data (Websocket API)

Besides the REST APIs that can be used for accessing live market data, Shrimpy also supports a variety of websockets. These websockets can be used to access real-time trade, order book, and BBO channels.

Trade Data Websockets (0.01 credits / subscription / hour)

Real-time trade data can be accessed through the “Trade Channel”. Subscriptions to each trading pair cost 0.01 credits / hour. That means if you subscribe to 100 different trading pairs, you will be charged 1 credit / hour.

Order Book Websockets (0.01 credits / subscription / hour)

Real-time order book data can be accessed through the “Order Book Channel”. Subscriptions to each trading pair cost 0.01 credits / hour. That means if you subscribe to 100 different trading pairs, you will be charged 1 credit / hour.

BBO Websockets (0.01 credits / subscription / hour)

Real-time BBO data can be accessed through the “BBO Channel”. Subscriptions to each trading pair cost 0.01 credits / hour. That means if you subscribe to 100 different trading pairs, you will be charged 1 credit / hour.

Did this answer your question?