Welcome to the official public API for the public-apis project!
This service supports CORS and requires no authentication to use. All responses are sent over HTTPS as well.
Please note that this service is still in beta, so some aspects are subject to change (base URL, documentation, etc).
If you would like to leave feedback or request a feature, please open an issue. If you would like to contribute, feel free to open a pull request.
https://github.com/davemachado/public-api
List all entries currently cataloged in the project
| Parameter | Type | Data Type | Description | Required |
|---|---|---|---|---|
| title | query | string | name of entry (matches via substring - i.e. "at" would return "cat" and "atlas") | No |
| description | query | string | description of entry (matches via substring) | No |
| auth | query | string | auth type of entry (can only be values matching in project or null) | No |
| https | query | bool | return entries that support HTTPS or not | No |
| cors | query | string | CORS support for entry ("yes", "no", or "unknown") | No |
| category | query | string | return entries of a specific category | No |
/entries?category=animals&https=true
List a single entry selected at random
| Parameter | Type | Data Type | Description | Required |
|---|---|---|---|---|
| title | query | string | name of entry (matches via substring - i.e. "at" would return "cat" and "atlas") | No |
| description | query | string | description of entry (matches via substring) | No |
| auth | query | string | auth type of entry (can only be values matching in project or null) | No |
| https | query | bool | return entries that support HTTPS or not | No |
| cors | query | string | CORS support for entry ("yes", "no", or "unknown") | No |
| category | query | string | return entries of a specific category | No |
/random?auth=null
List all categories
None
Check health of the running service
None
