Tri 1 Week 7 - Python RapidAPI Lecture Notes
APIs can be found all over the internet. A great consolidator of many APIs is RapidAPI. In this blog we will use a site to consolidates API stats. Learning a few lines of code and you can start extracting lots of data from the internet via APIs.
- Python, RapidAPI Terms & Shreya's Notes
- Covid19 RapidAPI Example: Step 1 - Find an API Provider
- Digital Coin Example
- Formatting Digital Coin example
- Go deeper into APIs
- Hacks
Python, RapidAPI Terms & Shreya's Notes
APIs and tooling like Jupyter docs allows many opportunities in fields like Data Science. As more and more developers use APIs, they build standards in how you setup a client, send requests and receive information...
- Shreya's Notes
- An API is a database that you can integrate into your own program
- You take an external source and use it in your own program, ex. spotify or youtube
- Pulling data from External Sources
Covid19 RapidAPI Example: Step 1 - Find an API Provider
First, find an API provider.
- RapidAPI is an API provider -- they build APIs to specific standards so they all work alike and are all similar in coding, but all pull data
- Go to this page for starters, the Corona virus World and India data- Under Code Snippets pick Python - Requests
RapidAPI, you will select Python Requests type of code to work with you Notebook.
- The headers is a dictionary data structure to send special messaging to the endpoint
- The requests.request() python function is used to send a request and retrieve their responses
Next step, is to format the response according to your data science needs
const axios = require("axios");
const options = {
method: 'GET',
url: 'https://corona-virus-world-and-india-data.p.rapidapi.com/api', # the URL is the endpoint to which the API is directed; the link that takes us to the API page
headers: { # the squigly brackets in the code are for a dictionary
'X-RapidAPI-Key': '2b7a1e07f1msheec8b665a35f05fp1a1019jsn337f301b5a47', # keys and values are in between the squigly brackets
'X-RapidAPI-Host': 'corona-virus-world-and-india-data.p.rapidapi.com'
}
};
axios.request(options).then(function (response) { # The response variable receives result of of the request in JSON text
console.log(response.data);
}).catch(function (error) {
console.error(error);
});
"""
Requests is a HTTP library for the Python programming language.
The goal of the project is to make HTTP requests simpler and more human-friendly.
"""
import requests
"""
RapidAPI is the world's largest API Marketplace.
Developers use Rapid API to discover and connect to thousands of APIs.
"""
url = "https://corona-virus-world-and-india-data.p.rapidapi.com/api"
headers = {
'x-rapidapi-key': "dec069b877msh0d9d0827664078cp1a18fajsn2afac35ae063",
'x-rapidapi-host': "corona-virus-world-and-india-data.p.rapidapi.com"
}
# Request Covid Data
response = requests.request("GET", url, headers=headers)
# print(response.text) # uncomment this line to see raw data
# print(response.json())
# EXTRACTING DATA FROM THE API
# This code looks for "world data"
print("World Totals")
world = response.json().get('world_total') # ".json()" code turns response to json() so we can extract "world_total"
for key, value in world.items(): # for loop finds key and value pairs in the world --> prints the world keys and values (data)
print(key, value)
print()
# This code looks for USA in "countries_stats"
print("Country Totals")
countries = response.json().get('countries_stat') # countries_stat is a key
for country in countries: # countries is a list
if country["country_name"] == "USA": # telling the API to filter for the USA data
for key, value in country.items(): # this finds key, value pairs in country
print(key, value) # prints the USA keys and values (data)
# RapidAPI page https://rapidapi.com/Coinranking/api/coinranking1/
# Begin Rapid API Code
import requests
url = "https://coinranking1.p.rapidapi.com/coins"
querystring = {"referenceCurrencyUuid":"yhjMzLPhuIDl","timePeriod":"24h","tiers[0]":"1","orderBy":"marketCap","orderDirection":"desc","limit":"50","offset":"0"}
headers = {
"X-RapidAPI-Key": "2b7a1e07f1msheec8b665a35f05fp1a1019jsn337f301b5a47", # place your key here; it is given to you on the API page after you subscribe to the API - need to subscribe to each API you use
"X-RapidAPI-Host": "coinranking1.p.rapidapi.com"
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
# End Rapid API Code
json = response.json() # convert response to python json object
# Observe data from an API. This is how data transports over the internet in a "JSON" text form
# - The JSON "text" is formed in dictionary {} and list [] divisions
# - To read the result, Data Scientist of Developer converts JSON into human readable form
# - Review the first line, look for the keys -- "status" and "data"
Formatting Digital Coin example
JSON text transferred from the API in the previous cell was converted to a Python Dictionary called json. The "coins" in the dictionary contain a list of the most relevant data. Look at the code and comments to see how the original text is turned into something understandable. Additionally, there are error check to make sure we are starting the code with the expectation that the API was run correctly.
"""
This cell is dependent on valid run of API above.
- try and except code is making sure "json" was properly run above
- inside second try is code that is used to process Coin API data
Note. Run this cell repeatedly to format data without re-activating API
"""
try:
print("JSON data is Python type: " + str(type(json)))
try:
# Extracting Coins JSON status, if the API worked
status = json.get('status')
print("API status: " + status)
print()
# Extracting Coins JSON data, data about the coins
data = json.get('data')
# Procedural abstraction of Print code for coins
def print_coin(c):
print(c["symbol"], c["price"])
print("Icon Url: " + c["iconUrl"])
print("Rank Url: " + c["coinrankingUrl"])
# Coins data was observed to be a list
for coin in data['coins']:
print_coin(coin)
print()
except:
print("Did you insert a valid key in X-RapidAPI-Key of API cell above?")
print(json) # prints the name of each type of bitcoin in the database, with the Icon URL and Rank URL of each type underneath the name
except:
print("This cell is dependent on running API call in cell above!")
Go deeper into APIs
Web Development vs Jupyter Notebook. A notebook is certainly a great place to start. But, for your end of Trimester project we want you to build the skill to reference and use APIs within your Project. Here are some resources to get you started with this journey.
- In the Nighthawk Coders APCSP you can find an Overview and Examples using APIs:APCSP APIs menu- Using Covid RapidAPI
- JavaScript frontend API code in APCSP Fastpages GitHub repo: https://github.com/nighthawkcoders/APCSP/blob/master/_posts/2022-07-10-PBL-rapidapi.md
- Making a Jokes API (this will next API tech talk)
- Frontend. JavaScript frontend code in APCSP fastpages GitHub repo: https://github.com/nighthawkcoders/APCSP/blob/master/_posts/2022-07-10-PBL-jokes.md
- Backend Endpoints. Python code that allows Frontend access: https://github.com/nighthawkcoders/flask_portfolio/blob/main/api.py
- Backend Jokes Management. Python code that support Create, Read, Update, Delete (CRUD): https://github.com/nighthawkcoders/flask_portfolio/blob/main/model_jokes.py
Hacks
Find and use an API as part of your project. An API and a little coding logic will be a big step toward getting meaningful data for a project. There are many API providers, find one that might work for your project to complete this hack. When picking an API you are looking for something that will work with either JavaScript Fetch or Python Request. Here are some samples, these are not qualified in any way.
Show API and format results in either Web Page or Jupyter Notebook. Ultimately, I will expect that we do APIs in backend (Python/Flask). However, for this Hack you can pick your preference. We will discuss pros and cons in next API tech talk.
import requests
url = "https://tasty.p.rapidapi.com/recipes/auto-complete"
querystring = {"prefix":"chicken soup"}
headers = {
"X-RapidAPI-Key": "2b7a1e07f1msheec8b665a35f05fp1a1019jsn337f301b5a47",
"X-RapidAPI-Host": "tasty.p.rapidapi.com"
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
import requests
import json
url = "https://tasty.p.rapidapi.com/recipes/auto-complete"
querystring = {"prefix":"chicken soup"}
headers = {
"X-RapidAPI-Key": "2b7a1e07f1msheec8b665a35f05fp1a1019jsn337f301b5a47",
"X-RapidAPI-Host": "tasty.p.rapidapi.com"
}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
print("Soups")
results = response.json().get('results')
for display in results:
if results ["display"] == "chicken soup":
json_formatted_str = json.dumps(results ["results"], indent=4)
print (json_formatted_str)