Skip to content

Commit

Permalink
add daily allowance endpoint
Browse files Browse the repository at this point in the history
  • Loading branch information
aakarim committed Oct 4, 2023
1 parent 45374f8 commit c7a12a8
Showing 1 changed file with 45 additions and 1 deletion.
46 changes: 45 additions & 1 deletion source/includes/_account.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,48 @@ print(response.json())
"paging": { "count": 10 }
}
}
```
```

## Daily Allowance

This endpoint retrieves your remaining daily allowance for your account.

<aside class="notice">
This endpoint is free to use.
</aside>

### HTTP Request

`GET https://api.lix-it.com/v1/account/allowances/daily`

### URL Parameters

Parameter | Description
--------- | -----------

```shell
curl "https://api.lix-it.com/v1/account/allowances/daily \
-H "Authorization: lixApiKey"
```
```python
import requests
url = "https://api.lix-it.com/v1/account/allowances/daily"
headers = {
'Authorization': lix_api_key
}
response = requests.request("GET", url, headers=headers)
print(response.json())
```
> The above command returns JSON structured like this:
```json
{
"requestsRemaining": 10000,
"refreshesAt": 1696512494 // represents the unix timestamp of when the daily allowance will refresh
}
```

0 comments on commit c7a12a8

Please sign in to comment.