Created
April 2, 2019 13:50
-
-
Save verdi327/18a5811c8e69bdf4024c7821169a4574 to your computer and use it in GitHub Desktop.
Understanding API Documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Youtube Subscription List Endpoint | |
Required: part - string: | |
Value Options: contentDetails, id, snippet, subscriberSnippet | |
Optional 1: | |
forChannelId: String | |
Description: The forChannelId parameter specifies a comma-separated list of channel IDs. | |
The API response will then only contain subscriptions matching those channels. | |
Optional 2: | |
maxResults: Integer | |
Description: The maxResults parameter specifies the maximum number of items that should be returned in the result set. | |
Acceptable values are 0 to 50, inclusive. The default value is 5. | |
Google Geocode Api | |
Request URL for Statue of Liberty | |
https://maps.googleapis.com/maps/api/geocode/json?address=statue+of+liberty&key=YOUR_API_KEY | |
Request URL for My Home Address: | |
https://maps.googleapis.com/maps/api/geocode/json?address=2701+W+Arch+St+Tampa,+FL&key=YOUR_API_KEY | |
Meetup API | |
Does this API require authentication? | |
Yes, for most requests | |
Does this API support CORS? | |
Yes, CORS is supported | |
Find the events search endpoint documentation. Describe in detail the response format of the events search endpoint. | |
Request URL: https://api.meetup.com/find/upcoming_events?&sign=true&photo-host=public&page=1 | |
The response is a JSON document containing many keys. Main keys are city (object), events (array) where each event has a nested Group key which describes the group which is putting on the event. | |
What are the limitations placed on the number of requests that can be made? | |
Within the response header, you can find the following: | |
X-RateLimit-Limit - The maximum number of requests that can be made in a window of time | |
X-RateLimit-Remaining - The remaining number of requests allowed in the current rate limit window | |
X-RateLimit-Reset - The number of seconds until the current rate limit window resets | |
List the errors that you can expect when making calls to this API. | |
400 Bad request when there was a problem with the request | |
401 Unauthorized when you don't provide a valid token | |
429 Too Many Requests when you've gone over your request rate limit | |
500 Internal Server Error if we messed up -- please let us know! | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment