├── .gitattributes
├── LICENSE
└── CONTRIBUTING.md
/.gitattributes:
--------------------------------------------------------------------------------
1 | * text=auto
2 |
3 | /.github export-ignore
4 | /build export-ignore
5 | .travis.yml export-ignore
6 | README.md export-ignore
7 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2021 public-apis
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing to public-apis
2 |
3 | > While the masses of pull requests and community involvement is appreciated, some pull requests have been specifically
4 | opened to market company APIs that offer paid solutions. This API list is not a marketing tool, but a tool to help the
5 | community build applications and use free, public APIs quickly and easily. Pull requests that are identified as marketing attempts will not be accepted.
6 | >
7 | > Please make sure the API you want to add has a full free access or at least a free tier before submitting.
8 | >
9 | > Thanks for understanding! :)
10 |
11 | ## Formatting
12 |
13 | Current API entry format:
14 |
15 | | API | Description | Auth | HTTPS | CORS |
16 | | --- | --- | --- | --- | --- |
17 | | API Title(Link to API documentation) | Description of API | Does this API require authentication? * | Does the API support HTTPS? | Does the API support [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)? * |
18 |
19 | Example entry:
20 |
21 | ```
22 | | [NASA](https://api.nasa.gov) | NASA data, including imagery | No | Yes | Yes |
23 | ```
24 |
25 | \* Currently, the only accepted inputs for the `Auth` field are as follows:
26 |
27 | * `OAuth` - _the API supports OAuth_
28 | * `apiKey` - _the API uses a private key string/token for authentication - try and use the correct parameter_
29 | * `X-Mashape-Key` - _the name of the header which may need to be sent_
30 | * `No` - _the API requires no authentication to run_
31 | * `User-Agent` - _the name of the header to be sent with requests to the API_
32 |
33 | \* Currently, the only accepted inputs for the `CORS` field are as follows:
34 |
35 | * `Yes` - _the API supports CORS_
36 | * `No` - _the API does not support CORS_
37 | * `Unknown` - _it is unknown if the API supports CORS_
38 |
39 | _Without proper [CORS configuration](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) an API will only be usable server side._
40 |
41 | After you've created a branch on your fork with your changes, it's time to [make a pull request][pr-link].
42 |
43 | *Please follow the guidelines given below while making a Pull Request to the Public APIs*
44 |
45 | ## Pull Request Guidelines
46 |
47 | * Continue to follow the alphabetical ordering that is in place per section.
48 | * Each table column should be padded with one space on either side.
49 | * If an API seems to fall into multiple categories, please place the listing within the section most in line with the services offered through the API. For example, the Instagram API is listed under `Social` since it is mainly a social network, even though it could also apply to `Photography`.
50 | * Add one link per Pull Request.
51 | * Make sure the PR title is in the format of `Add Api-name API` *for e.g.*: `Add Blockchain API`
52 | * Use a short descriptive commit message. *for e.g.*: ❌`Update Readme.md` ✔ `Add Blockchain API to Cryptocurrency`
53 | * Search previous Pull Requests or Issues before making a new one, as yours may be a duplicate.
54 | * Don't mention the TLD(Top Level Domain) in the name of the API. *for e.g.*: ❌Gmail.com ✔Gmail
55 | * Please make sure the API name does not end with `API`. *for e.g.*: ❌Gmail API ✔Gmail
56 | * Please make sure the API has proper documentation.
57 | * Please make sure you squash all commits together before opening a pull request. If your pull request requires changes upon review, please be sure to squash all additional commits as well. [This wiki page][squash-link] outlines the squash process.
58 | * Target your Pull Request to the `master` branch of the `public-apis`
59 |
60 | Once you’ve submitted a pull request, the collaborators can review your proposed changes and decide whether or not to incorporate (pull in) your changes.
61 |
62 | ### Pull Request Pro Tips
63 |
64 | * [Fork][fork-link] the repository and [clone][clone-link] it locally.
65 | Connect your local repository to the original `upstream` repository by adding it as a [remote][remote-link].
66 | Pull in changes from `upstream` often so that you stay up to date and so when you submit your pull request,
67 | merge conflicts will be less likely. See more detailed instructions [here][syncing-link].
68 | * Create a [branch][branch-link] for your edits.
69 | * Contribute in the style of the project as outlined above. This makes it easier for the collaborators to merge
70 | and for others to understand and maintain in the future.
71 |
72 | ### Open Pull Requests
73 |
74 | Once you’ve opened a pull request, a discussion will start around your proposed changes.
75 |
76 | Other contributors and users may chime in, but ultimately the decision is made by the collaborators.
77 |
78 | During the discussion, you may be asked to make some changes to your pull request.
79 |
80 | If so, add more commits to your branch and push them – they will automatically go into the existing pull request. But don't forget to squash them.
81 |
82 | Opening a pull request will trigger a Travis CI build to check the validity of all links in the project. After the build completes, **please ensure that the build has passed**. If the build did not pass, please view the Travis CI log and correct any errors that were found in your contribution.
83 |
84 | *Thanks for being a part of this project, and we look forward to hearing from you soon!*
85 |
86 | [branch-link]:
87 | [clone-link]:
88 | [fork-link]:
89 | [oauth-link]:
90 | [pr-link]:
91 | [remote-link]:
92 | [syncing-link]:
93 | [squash-link]:
94 |
95 |
--------------------------------------------------------------------------------