Rate Limits for the API Data Endpoints are Changing!

banner-1165973_1920.jpg

Pricing plans are NOT changing!

Let’s get that out of the way so there is no confusion. None of our pricing plans will change. All of the data endpoints are still free. The difference is you will now be required to send your public API key in order to access higher rate limits.

To prevent disruption of service, please follow the updated documentation in our developer APIs here. Start sending each of your data requests with the public API key in the header. That way you have a smooth transition to the new request format.

Keep reading to get all of your questions answered!

What are the new rate limits?

We now support tiered rate limits with the following break down.

  • Public Endpoints

    • Without an API Key: 10 requests per minute (Previously was 60)

    • With User API Key: 60 requests per minute

    • With Master API Key: 1000 requests per minute (Previously was 60)

  • Private Endpoints

    • Without an API Key: N/A

    • With User API Key: 60 requests per minute

    • With Master API Key: 1000 requests per minute (Previously was 60)

We have reduced the rate limit for accessing public endpoints to 10 requests per minute to encourage developers to sign up to use Shrimpy. We have also drastically increased the rate limit for using master keys so that once a user signs up, they have generous request limitations.

Master Keys - These are the keys that are generated by the developer through the Shrimpy Universal Crypto Exchange API application. These keys should be kept secure and never sent to any users of your services.

User Keys - These keys are generated from the Master Keys and can be provided to the users of your service. This allows users to directly communicate with Shrimpy, collect data, and execute trades without being routed through your servers.

Please note, the new rate limit for the Master API keys is 1,000 requests per minute. This is significantly higher than the previous request limit of 60 requests per minute when accessing the public data endpoints.

Why are we doing this?

To be blunt, our team realized it was not in the best interest of ourselves or our developer community to be able to access Shrimpy’s data without ever creating an account. Since we have an ambitious road map ahead of us, we need to be able to communicate with our developers. That way we can notify developers of updates, breaking changes, and new additions to the developer APIs. Without requiring a sign up, developers would be able to access Shrimpy’s data and not be aware of the times we make breaking changes.

To prevent these communication issues, we encourage everyone to sign up for a Shrimpy developer API account. It is 100% free to sign up and access your API keys.

Sign up here.

This update will take affect on July 29th at 12pm PST. The documentation has already been updated, so you should move your API calls over to the new format as soon as possible. On July 29th, we will begin rate limiting the calls to the public endpoints.

What you need to do

To ensure you have an uninterrupted experience with Shrimpy, please do the following things:

  1. Create a Shrimpy developer API account here. It’s free.

  2. Generate a developer API key once you have logged into your account.

  3. Read through the updated documentation here.

  4. Update your requests to include your public Master or User API key in the header.

An example

Adding your developer API key to the request header is easy. In the example below, we demonstrate how this can be done with Postman. We can see the “dev-shrimpy-api-key” is specified, which provides us access to the higher rate limits.

shrimpy_api_header_example.PNG

Get Building

That’s all! Now that you have access to these higher rate limits, we look forward to seeing everything you are building. Enjoy this new freedom when developing the future of the crypto space.

If you ever need anything, don’t hesitate to reach out in our Telegram or Discord. We’re always excited to learn more about what everyone is building, answer questions, and help any way we can.

About Shrimpy

Shrimpy is a free application for constructing custom cryptocurrency index funds, rebalancing, and managing a diverse portfolio of digital assets. Automate your portfolio by linking to any of the 16 crypto exchanges we support.

Shrimpy’s Universal Crypto Exchange APIs are designed for developers. Integrating with our unified APIs gives you instant access to uniform endpoints for trading, data collection, user management, and more across every major cryptocurrency exchange.

~The Shrimpy Team