Skip to content

Commit 0668518

Browse files
committed
chore: add statistics documentation
1 parent fb32039 commit 0668518

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,20 @@ const response = await client.sendRequest("GET", {
152152
console.log(response);
153153
```
154154

155-
### Get account statistics
155+
### [Get account statistics](https://scrape.do/documentation/#usage-statistics-api?utm_source=github&utm_medium=node-client)
156+
157+
The statistics() method allows you to retrieve real-time usage statistics for your subscription. This API call returns details such as your current subscription status, the number of concurrent requests allowed, the total and remaining requests per month, and how many concurrent requests are still available.
158+
159+
Key information retrieved:
160+
161+
- IsActive: Indicates whether your subscription is active.
162+
- ConcurrentRequest: The total number of concurrent requests your subscription supports.
163+
- MaxMonthlyRequest: The maximum number of requests allowed per month.
164+
- RemainingConcurrentRequest: The number of concurrent requests you have left at the current time.
165+
- RemainingMonthlyRequest: The remaining number of requests you can send this month.
166+
167+
> [!WARNING]
168+
> For security reasons, you can send up to 10 requests per minute to this endpoint. If you exceed this rate, you will receive a 429 Too Many Requests error.
156169
157170
```typescript
158171
const client = new ScrapeDo("example_token");

0 commit comments

Comments
 (0)