@bitflowlabs/core-sdk 2.4.1 → 2.4.2

package/README.md

@@ -4,7 +4,7 @@ Bitflow SDK is a powerful and easy-to-use library for interacting with the Bitfl
 
 All Bitflow API endpoints are **publicly accessible without an API key**. Unauthenticated requests are subject to a default rate limit of **500 requests per minute per IP**.
 
-If your integration requires higher limits, use the [rate limit request template](./RATE_LIMIT_REQUEST.md) to email **help@bitflow.finance** with a pre-filled form. You can also reach the team on [Discord](https://discord.gg/DY4yNyHyhT).
+If your integration requires higher limits, see the [Rate Limit Request](#rate-limit-request) section to email **help@bitflow.finance** with a pre-filled form. You can also reach the team on [Discord](https://discord.gg/DY4yNyHyhT).
 
 # Table of Contents
 
@@ -21,6 +21,7 @@ If your integration requires higher limits, use the [rate limit request template
   - [Executing Swap (uses `@stacks/connect`)](#executing-swap-uses-stacksconnect)
 - [Types](#types)
 - [Troubleshooting](#troubleshooting)
+- [Rate Limit Request](#rate-limit-request)
 - [License](#license)
 
 # Installation
@@ -69,7 +70,7 @@ Create a `.env` file in your project root with the following variables:
 ```bash
 # Bitflow Core API — publicly accessible, no key required
 BITFLOW_API_HOST=https://bitflowsdk-api-test-7owjsmt8.uk.gateway.dev
-# Optional: API key for higher rate limits (see RATE_LIMIT_REQUEST.md to request one)
+# Optional: API key for higher rate limits (see Rate Limit Request section below)
 BITFLOW_API_KEY=<your_api_key_here>
 
 # Your provider address
@@ -219,6 +220,25 @@ If you encounter any issues while using the Bitflow SDK, please check the follow
 2. Make sure you have the latest version of the SDK installed.
 3. Check that you're using a valid Stacks address for the senderAddress parameter.
 
+# Rate Limit Request
+
+If your integration needs more than **500 requests per minute per IP**, click the link below to open a pre-filled email in your mail client:
+
+**[Request higher rate limits](mailto:help@bitflow.finance?subject=API%20Rate%20Limit%20Increase%20Request%20-%20%5BYour%20Project%20Name%5D&body=Hi%20Bitflow%20team%2C%0D%0A%0D%0AI%27m%20integrating%20the%20Bitflow%20SDK%20and%20would%20like%20to%20request%20an%20API%20key%20with%20increased%20rate%20limits.%0D%0A%0D%0AProject%20%2F%20Application%20name%3A%20%5Be.g.%20MyDeFi%20App%5D%0D%0ABrief%20description%3A%20%5BWhat%20your%20app%20does%20and%20how%20it%20uses%20the%20Bitflow%20API%5D%0D%0AWebsite%20%2F%20repo%20%28if%20public%29%3A%20%5BURL%20or%20N%2FA%5D%0D%0A%0D%0AAPIs%20I%20need%20higher%20limits%20for%20%28delete%20as%20applicable%29%3A%0D%0A-%20Bitflow%20Core%20API%20%28bitflow-sdk-api-gateway-7owjsmt8.uc.gateway.dev%29%0D%0A-%20Keeper%20API%20%28bitflow-keeper-7owjsmt8.uc.gateway.dev%29%0D%0A-%20Stacks%20Node%20%28node.bitflowapis.finance%29%0D%0A%0D%0AExpected%20request%20volume%3A%20%5Be.g.%20~2%2C000%20requests%2Fminute%20during%20peak%20hours%5D%0D%0A%0D%0AUse%20case%3A%20%5Be.g.%20Server-side%20data%20aggregation%2C%20real-time%20price%20feeds%20for%20N%20users%5D%0D%0A%0D%0AContact%20name%3A%20%5BYour%20name%5D%0D%0ADiscord%20handle%20%28optional%29%3A%20%5Be.g.%20%40yourhandle%5D%0D%0A%0D%0AThanks!)**
+
+> If the link doesn't open your mail client, email **help@bitflow.finance** with the subject `API Rate Limit Increase Request` and include the following:
+
+- **Project / Application name** — e.g. MyDeFi App
+- **Brief description** — What your app does and how it uses the Bitflow API
+- **Website / repo (if public)** — URL or N/A
+- **APIs you need higher limits for** — Core API, Keeper API, Stacks Node (or all)
+- **Expected request volume** — e.g. ~2,000 requests/minute during peak hours
+- **Use case** — e.g. Server-side data aggregation, real-time price feeds for N users
+- **Contact name**
+- **Discord handle** (optional)
+
+We aim to respond within 2 business days. For urgent requests, reach out on [Discord](https://discord.gg/DY4yNyHyhT).
+
 # License
 
 This project is licensed under the MIT License - see the LICENSE file for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitflowlabs/core-sdk",
-  "version": "2.4.1",
+  "version": "2.4.2",
   "description": "SDK for interacting with Bitflow Protocol",
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",