Skip to content

Commit

Permalink
update REDME
Browse files Browse the repository at this point in the history
  • Loading branch information
dchoi27 authored Jun 7, 2023
1 parent 1b903d3 commit c9343b7
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ Full API reference doc for the JS client are available at https://web3-storage.g

You can also find a [how-to guide for working with the JS client](https://web3.storage/docs/how-tos/w3name/) included in the [Web3.Storage](https://web3.storage) documentation.

There is a rate limit of 30 requests per 10 seconds per IP.

### cURL

You can easily get the current value for any name by sending an HTTP request to `https://name.web3.storage/name/:key`, where `:key` is the name string. This will return a JSON object with the following shape:
Expand All @@ -71,6 +73,8 @@ You should see output similar to this:
}
```

There is a rate limit of 30 requests per 10 seconds per IP.

**See https://github.com/web3-storage/w3name/tree/main/packages/api for documentation on other available API endpoints 📖🔍**

<!-- TODO: add link to swagger api docs once published -->
Expand Down

0 comments on commit c9343b7

Please sign in to comment.