Skip to content

add callout for api usage #993

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add callout for api usage #993

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions content/docs/stacks/api/usage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ description: Understand general concepts, response codes, and authentication str

The Stacks API is built on REST principles, enforcing HTTPS for all requests to ensure data security, integrity, and privacy. The base URL for all API requests is:

```plaintext
https://api.mainnet.hiro.so
```
`https://api.mainnet.hiro.so`

### Making requests

Expand All @@ -30,6 +28,10 @@ $ curl -L 'https://api.hiro.so/extended' \
-H 'X-API-Key: $HIRO_API_KEY'
```

<Callout title="API usage">
To view your API usage, log into the [Hiro Platform](https://platform.hiro.so/) and select "API Usage" in the top navigation bar.
</Callout>

### Response codes

The Stacks API uses standard HTTP response codes to indicate the success or failure of an API request:
Expand Down
4 changes: 4 additions & 0 deletions content/docs/stacks/token-metadata-api/usage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ $ curl -L 'https://api.hiro.so/metadata/v1/' \
-H 'X-API-Key: $HIRO_API_KEY'
```

<Callout title="API usage">
To view your API usage, log into the [Hiro Platform](https://platform.hiro.so/) and select "API Usage" in the top navigation bar.
</Callout>

You should get a response back that resembles the following:

```json
Expand Down