8000 Document unauth'd rate limited calls · vlarsen/developer.github.com@426111f · GitHub
[go: up one dir, main page]

Skip to content

Commit 426111f

Browse files
committed
Document unauth'd rate limited calls
1 parent cb1369d commit 426111f

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

content/v3.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,8 +226,27 @@ You can also check your rate limit status without incurring an API hit.
226226
<%= headers 200 %>
227227
<%= json :rate => {:remaining => 4999, :limit => 5000} %>
228228

229-
Please [contact us](https://github.com/contact) to request white listed access for your application. We prefer sites that
230-
setup OAuth applications for their users.
229+
#### Unauthenticated rate limited requests
230+
231+
If you need to make unauthenticated calls but need to use a higher rate limit
232+
associated with your OAuth application, you can send over your client ID and
233+
secret in the query string.
234+
235+
<pre class="terminal">
236+
$ curl -i https://api.github.com/users/whatever?client_id=xxxxxxxxxxxxxx&client_secret=yyyyyyyyyyyyyyyyyyyyy
237+
238+
HTTP/1.1 200 OK
239+
Status: 200 OK
240+
X-RateLimit-Limit: 12500
241+
X-RateLimit-Remaining: 11966
242+
</pre>
243+
244+
This method should only used for server-to-server calls. You should never share
245+
your client secret with anyone or include it in client-side browser code.
246+
247+
Please [contact us](https://github.com/contact) to request white listed access
248+
for your application. We prefer sites that setup OAuth applications for their
249+
users.
231250

232251
## Conditional Requests
233252

0 commit comments

Comments
 (0)
0