Contributing¶

New APIs are added to the source project, public-apis on GitHub — not to this documentation site, which rebuilds automatically from it. Open your pull request there; once merged, it will show up here.

Not a marketing tool

Pull requests opened to promote paid products are not accepted. The API must have full free access, or at least a free tier, and must not require purchasing a physical device or paid service first.

Entry format¶

| [API Title](Link to API documentation) | Description of API | Auth | HTTPS | CORS |

Example:

| [NASA](https://api.nasa.gov) | NASA data, including imagery | No | Yes | Yes |

Auth field values¶

Value	Meaning
`No`	The API requires no authentication
`apiKey`	A private key/token is required
`OAuth`	The API supports OAuth
`X-Mashape-Key`	Name of the header that may need to be sent
`User-Agent`	Name of the header to send with requests

CORS field values¶

Value	Meaning
`Yes`	The API supports CORS
`No`	The API does not support CORS
`Unknown`	Not yet verified

Without CORS support, an API is only reliably usable server-side, not from browser JavaScript.

Pull request guidelines¶

Don't add an API that's already listed — update the existing entry instead.
Keep alphabetical order within the section.
Pad each table column with one space on either side.
Keep the description under 100 characters.
File the API under the section that best matches its primary purpose (e.g. Instagram goes under Social, not Photography).
One link per pull request.
PR title format: Add Api-name API (e.g. Add Blockchain API).
Commit message: short and descriptive (e.g. Add Blockchain API to Cryptocurrency).
Search existing issues/PRs first to avoid duplicates.
Don't include the TLD in the API name (Gmail, not Gmail.com).
Don't end the name with "API" (Gmail, not Gmail API).
Make sure the API has proper documentation.
Squash commits before opening the PR, and again if changes are requested.
Target the master branch of public-apis.

Full details, including the pull-request review process: see the CONTRIBUTING.md in the source repository.