Skip to content
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

Fix typos and improve wording in api.mdx #52

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix typos and improve wording in api.mdx #52

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
44d3c73
typos api.mdx
Dimitrolito Dec 5, 2024
62dd502
typos api.mdx
Dimitrolito Dec 5, 2024
8590131
typos api.mdx
Dimitrolito Dec 5, 2024
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
6 changes: 3 additions & 3 deletions docs/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ If you have any questions, comments, or suggestions, please reach out in the #gi
## Version 1

**Note that the public API limits individual IPs to a
maximum of 100 requests within a 5 minute window.**
maximum of 100 requests within a 5-minute window.**

### `GET /v1/poap/:poapTokenId/is-gitpoap`

Expand Down Expand Up @@ -183,7 +183,7 @@ This endpoint allows users to query for a list of all addresses that hold any Gi

### `GET /v1/address/:address/gitpoaps`

This endpoint allows users to query for some address's (either an ETH or ENS address) GitPOAPs. This returns data like:
This endpoint allows users to query for some addresses (either an ETH or ENS address) GitPOAPs. This returns data like:

```json
[
Expand Down Expand Up @@ -234,7 +234,7 @@ the following: `claimed`, `unclaimed`, `pending`, `minting`, and can be omitted

### `GET /v1/repo/:owner/:name/badge`

This endpoint generates a GitHub badge containing the count of minted GitPOAPs for a specified repo. The repo is specified with a GitHub owner and repo name & the endpoint will return a SVG for use in any `.md` file such as a `README.md`.
This endpoint generates a GitHub badge containing the count of minted GitPOAPs for a specified repo. The repo is specified with a GitHub owner and repo name & the endpoint will return an SVG for use in any `.md` file such as a `README.md`.

Using `ethereum/ethereum-org-website` as an example via [https://public-api.gitpoap.io/v1/repo/ethereum/ethereum-org-website/badge](https://public-api.gitpoap.io/v1/repo/ethereum/ethereum-org-website/badge), embed the badge in a `.md` file the following way:

Expand Down