How do I open the pull request?
- Click Open a pull request. GitHub opens the README in its editor and forks the repository for you.
- Find your API's category and add one row in alphabetical order.
- Click "Commit changes", then "Create pull request". Use the title
Add Name API. - Wait for the link check on the pull request to pass, and answer any review comments.
What does a row look like?
Each API is one line in its category's table:
| [Agify.io](https://agify.io) | Estimates the age from a first name | No | Yes | Yes |- API: The name, linked to the API's documentation. No TLD and no trailing "API": Gmail, not Gmail.com or Gmail API.
- Description: What it does, in 100 characters or fewer.
- Auth: One of No, apiKey, OAuth, X-Mashape-Key or User-Agent.
- HTTPS: Yes or No.
- CORS: Yes, No or Unknown. Without CORS an API only works server side.
What gets a pull request accepted?
- The API must be free, or have a free tier, and must not require buying a device or service to use it.
- One API per pull request.
- Put it in the single category that best matches what it does, in alphabetical order.
- Pad every table column with one space on each side.
- Title the pull request "Add Name API", e.g. Add Blockchain API, and squash your commits into one.
- Don't add a new version of an API that's already listed.
- The API needs proper documentation, and the link check that runs on your pull request must pass.
- Search open pull requests and issues first; your API may already be submitted.
The list isn't a marketing channel: pull requests that only promote a paid product are closed. The full rules are in the contributing guide.
What happens after it's merged?
Every day at 06:17 UTC this site reads the README and adds new APIs. Yours gets its own page with daily uptime checks, verified CORS support and code samples, and appears in its category, in search and in the JSON API.