API Rate Limits

1
// Check current rate limit status
2
const rateLimits = await openledger.rateLimits.retrieve();
3
4
console.log("Global rate limit:", rateLimits.data.global);
5
console.log("Write operations limit:", rateLimits.data.write);
6
console.log("Read operations limit:", rateLimits.data.read);
7
8
// Sample response:
9
// {
10
//   "data": {
11
//     "global": {
12
//       "limit": 60,
13
//       "remaining": 45,
14
//       "reset": 1630094380
15
//     },
16
//     "write": {
17
//       "limit": 30,
18
//       "remaining": 25,
19
//       "reset": 1630094380
20
//     },
21
//     "read": {
22
//       "limit": 60,
23
//       "remaining": 50,
24
//       "reset": 1630094380
25
//     },
26
//     "endpoints": {
27
//       "/v1/reports/generate": {
28
//         "limit": 10,
29
//         "remaining": 8,
30
//         "reset": 1630094380
31
//       }
32
//     }
33
//   }
34
// }

1
class OpenLedgerClient {
2
  constructor(apiKey, options = {}) {
3
    this.openledger = new OpenLedger({
4
      apiKey,
5
      environment: options.environment || "production",
6
    });
7
8
    this.requestQueue = new Map();
9
    this.rateLimits = {
10
      global: { limit: 60, remaining: 60, reset: 0 },
11
      write: { limit: 30, remaining: 30, reset: 0 },
12
      read: { limit: 60, remaining: 60, reset: 0 },
13
    };
14
  }
15
16
  async makeRequest(category, endpoint, method, ...args) {
17
    // Get the target method from the SDK
18
    const methodParts = endpoint.split(".");
19
    let target = this.openledger;
20
    for (const part of methodParts) {
21
      target = target[part];
22
    }
23
24
    if (typeof target !== "function") {
25
      throw new Error(`Invalid endpoint: ${endpoint}`);
26
    }
27
28
    // Check if we're near rate limit and should throttle
29
    const rateLimit = this.rateLimits[category];
30
    const now = Math.floor(Date.now() / 1000);
31
32
    if (rateLimit.remaining < 5 && rateLimit.reset > now) {
33
      const delay = (rateLimit.reset - now) * 1000;
34
      console.log(
35
        `Approaching rate limit for ${category}. Delaying request for ${delay}ms`
36
      );
37
      await new Promise((resolve) => setTimeout(resolve, delay));
38
    }
39
40
    try {
41
      // Make the actual request
42
      const response = await target.apply(this.openledger, args);
43
44
      // Update rate limit info from headers
45
      this.updateRateLimits(response.headers);
46
47
      return response;
48
    } catch (error) {
49
      if (error.status === 429) {
50
        const retryAfter = error.headers["retry-after"]
51
          ? parseInt(error.headers["retry-after"], 10) * 1000
52
          : 30000;
53
54
        console.log(
55
          `Rate limit exceeded. Retrying after ${retryAfter / 1000} seconds...`
56
        );
57
58
        // Wait and retry
59
        await new Promise((resolve) => setTimeout(resolve, retryAfter));
60
        return this.makeRequest(category, endpoint, method, ...args);
61
      }
62
63
      throw error;
64
    }
65
  }
66
67
  updateRateLimits(headers) {
68
    if (headers["x-ratelimit-limit"]) {
69
      const category = headers["x-ratelimit-category"] || "global";
70
71
      this.rateLimits[category] = {
72
        limit: parseInt(headers["x-ratelimit-limit"], 10),
73
        remaining: parseInt(headers["x-ratelimit-remaining"], 10),
74
        reset: parseInt(headers["x-ratelimit-reset"], 10),
75
      };
76
    }
77
  }
78
79
  // Helper methods for common operations
80
  async getAccount(id) {
81
    return this.makeRequest("read", "accounts.retrieve", "GET", id);
82
  }
83
84
  async createTransaction(data) {
85
    return this.makeRequest("write", "transactions.create", "POST", data);
86
  }
87
88
  async listTransactions(params) {
89
    return this.makeRequest("read", "transactions.list", "GET", params);
90
  }
91
}
92
93
// Usage:
94
const client = new OpenLedgerClient("YOUR_API_KEY", {
95
  environment: "production",
96
});
97
98
async function main() {
99
  // These requests will be automatically rate-limited if needed
100
  const account = await client.getAccount("acct_12345");
101
  console.log("Account:", account.data);
102
103
  const transactions = await client.listTransactions({ limit: 10 });
104
  console.log("Transactions:", transactions.data);
105
}
106
107
main().catch(console.error);