[Python] APIリクエストをする方法

2025-01-18更新日: 2025-01-18

PythonでAPIリクエストを行うには、主にrequestsライブラリを使用します。このライブラリはHTTPリクエストを簡単に送信できるため、APIとの通信に非常に便利です。

まず、requests.get()メソッドを使用してGETリクエストを送信し、APIからデータを取得します。レスポンスはResponseオブジェクトとして返され、response.json()メソッドでJSON形式のデータを取得できます。

POSTリクエストを送信する場合は、requests.post()メソッドを使用し、必要なデータをdataまたはjsonパラメータで指定します。

目次から探す

PythonでAPIリクエストを行うための準備
requestsライブラリを使ったAPIリクエスト
urllibライブラリを使ったAPIリクエスト
APIレスポンスの処理
応用例
まとめ

PythonでAPIリクエストを行うための準備

APIリクエストを行うためには、まず必要なライブラリをインストールし、APIキーを取得し、APIドキュメントを理解することが重要です。

以下にその手順を詳しく説明します。

必要なライブラリのインストール

PythonでAPIリクエストを行うために、主に使用されるライブラリはrequestsとurllibです。

これらのライブラリをインストールする方法を見ていきましょう。

requestsライブラリのインストール

requestsライブラリは、HTTPリクエストを簡単に扱うためのライブラリです。

以下のコマンドを使用してインストールできます。

pip install requests

urllibライブラリのインストール

urllibはPythonに標準で含まれているライブラリで、追加のインストールは不要です。

Pythonをインストールすると自動的に利用可能になります。

APIキーの取得方法

多くのAPIは、利用するためにAPIキーを必要とします。

APIキーは、サービスに登録することで取得できます。

一般的な手順は以下の通りです。

API提供者のウェブサイトにアクセス
アカウントを作成
APIキーを生成または取得
APIキーを安全に保管

APIドキュメントの読み方

APIを利用する際には、APIドキュメントを理解することが不可欠です。

ドキュメントには、以下の情報が含まれています。

項目	説明
エンドポイント	APIリクエストを送信するURL
リクエストメソッド	GET、POST、PUT、DELETEなどの`HTTPメソッド`
パラメータ	リクエストに含める必要なデータ
レスポンス形式	APIから返されるデータの形式(JSON、XMLなど)

APIドキュメントをしっかりと読み、必要な情報を把握することで、スムーズにAPIリクエストを行うことができます。

requestsライブラリを使ったAPIリクエスト

requestsライブラリは、PythonでHTTPリクエストを簡単に扱うための非常に便利なツールです。

ここでは、requestsライブラリを使ったAPIリクエストの基本から、さまざまなリクエスト方法について詳しく説明します。

requestsライブラリの基本

requestsライブラリを使用するには、まずインポートします。

以下のようにして、基本的な使い方を確認できます。

import requests

GETリクエストの送信

GETリクエストは、指定したリソースからデータを取得するために使用されます。

基本的なGETリクエスト

基本的なGETリクエストの例を以下に示します。

import requests
response = requests.get('https://api.example.com/data')
print(response.text)

このコードを実行すると、指定したURLからデータが取得され、レスポンスの内容が表示されます。

パラメータ付きGETリクエスト

GETリクエストにパラメータを追加する場合は、params引数を使用します。

import requests
params = {'key1': 'value1', 'key2': 'value2'}
response = requests.get('https://api.example.com/data', params=params)
print(response.text)

この例では、key1とkey2というパラメータを持つGETリクエストが送信されます。

POSTリクエストの送信

POSTリクエストは、サーバーにデータを送信するために使用されます。

基本的なPOSTリクエスト

基本的なPOSTリクエストの例を以下に示します。

import requests
data = {'key1': 'value1', 'key2': 'value2'}
response = requests.post('https://api.example.com/data', data=data)
print(response.text)

このコードでは、指定したURLにデータを送信し、レスポンスを表示します。

JSONデータを送信するPOSTリクエスト

JSON形式のデータを送信する場合は、json引数を使用します。

import requests
import json
data = {'key1': 'value1', 'key2': 'value2'}
response = requests.post('https://api.example.com/data', json=data)
print(response.text)

この例では、JSON形式でデータが送信されます。

PUTリクエストの送信

PUTリクエストは、既存のリソースを更新するために使用されます。

以下はその例です。

import requests
data = {'key1': 'new_value1'}
response = requests.put('https://api.example.com/data/1', json=data)
print(response.text)

このコードでは、IDが1のリソースを更新します。

DELETEリクエストの送信

DELETEリクエストは、指定したリソースを削除するために使用されます。

以下はその例です。

import requests
response = requests.delete('https://api.example.com/data/1')
print(response.status_code)

このコードでは、IDが1のリソースを削除し、レスポンスのステータスコードを表示します。

ヘッダー情報の追加

リクエストにヘッダー情報を追加するには、headers引数を使用します。

import requests
headers = {'Authorization': 'Bearer YOUR_API_KEY'}
response = requests.get('https://api.example.com/data', headers=headers)
print(response.text)

この例では、Authorizationヘッダーを追加してリクエストを送信します。

タイムアウトの設定

リクエストにタイムアウトを設定するには、timeout引数を使用します。

import requests
try:
    response = requests.get('https://api.example.com/data', timeout=5)
    print(response.text)
except requests.exceptions.Timeout:
    print("リクエストがタイムアウトしました。")

このコードでは、5秒以内にレスポンスが返ってこない場合、タイムアウトエラーが発生します。

urllibライブラリを使ったAPIリクエスト

urllibライブラリは、Pythonに標準で含まれているライブラリで、URLの操作やHTTPリクエストを行うための機能を提供します。

ここでは、urllibライブラリを使ったAPIリクエストの基本から、GETおよびPOSTリクエストの送信方法、エラーハンドリングについて説明します。

urllibライブラリの基本

urllibライブラリを使用するには、まずインポートします。

以下のようにして、基本的な使い方を確認できます。

import urllib.request
import urllib.parse

GETリクエストの送信

GETリクエストを送信するには、urllib.request.urlopenメソッドを使用します。

以下はその例です。

import urllib.request
url = 'https://api.example.com/data'
response = urllib.request.urlopen(url)
data = response.read()
print(data.decode('utf-8'))

このコードを実行すると、指定したURLからデータが取得され、レスポンスの内容が表示されます。

POSTリクエストの送信

POSTリクエストを送信する場合は、urllib.request.Requestを使用してリクエストを作成し、データを送信します。

以下はその例です。

import urllib.request
import urllib.parse
url = 'https://api.example.com/data'
data = {'key1': 'value1', 'key2': 'value2'}
data_encoded = urllib.parse.urlencode(data).encode('utf-8')
request = urllib.request.Request(url, data=data_encoded, method='POST')
response = urllib.request.urlopen(request)
response_data = response.read()
print(response_data.decode('utf-8'))

このコードでは、指定したURLにデータをPOSTし、レスポンスを表示します。

エラーハンドリング

APIリクエストを行う際には、エラーハンドリングが重要です。

urllibでは、HTTPErrorやURLErrorを使用してエラーを処理できます。

以下はその例です。

import urllib.request
from urllib.error import HTTPError, URLError
url = 'https://api.example.com/data'
try:
    response = urllib.request.urlopen(url)
    data = response.read()
    print(data.decode('utf-8'))
except HTTPError as e:
    print(f'HTTPエラーが発生しました: {e.code}')
except URLError as e:
    print(f'URLエラーが発生しました: {e.reason}')

このコードでは、リクエスト中に発生したHTTPエラーやURLエラーをキャッチし、適切なメッセージを表示します。

APIレスポンスの処理

APIからのレスポンスを適切に処理することは、アプリケーションの動作において非常に重要です。

ここでは、JSONおよびXMLレスポンスの解析方法、エラーレスポンスの処理、レスポンスのステータスコードの確認方法について説明します。

JSONレスポンスの解析

多くのAPIはJSON形式でデータを返します。

Pythonでは、jsonモジュールを使用してJSONレスポンスを解析できます。

以下はその例です。

import requests
response = requests.get('https://api.example.com/data')
data = response.json()  # JSONレスポンスを解析
print(data)

このコードでは、response.json()メソッドを使用して、レスポンスのJSONデータをPythonの辞書型に変換しています。

XMLレスポンスの解析

XML形式のレスポンスを解析するには、xml.etree.ElementTreeモジュールを使用します。

以下はその例です。

import requests
import xml.etree.ElementTree as ET
response = requests.get('https://api.example.com/data.xml')
root = ET.fromstring(response.content)  # XMLレスポンスを解析
for child in root:
    print(child.tag, child.text)

このコードでは、ET.fromstring()を使用してXMLデータを解析し、各要素のタグとテキストを表示しています。

エラーレスポンスの処理

APIからのエラーレスポンスを適切に処理することも重要です。

以下は、エラーレスポンスを処理する例です。

import requests
response = requests.get('https://api.example.com/data')
if response.status_code != 200:
    print(f'エラーが発生しました: {response.status_code}')
    print(response.text)  # エラーメッセージを表示
else:
    data = response.json()
    print(data)

このコードでは、ステータスコードが200でない場合にエラーメッセージを表示します。

レスポンスのステータスコードの確認

APIレスポンスのステータスコードを確認することで、リクエストが成功したかどうかを判断できます。

以下はその例です。

import requests
response = requests.get('https://api.example.com/data')
status_code = response.status_code
if status_code == 200:
    print('リクエストは成功しました。')
elif status_code == 404:
    print('リソースが見つかりません。')
elif status_code == 500:
    print('サーバーエラーが発生しました。')
else:
    print(f'その他のエラー: {status_code}')

このコードでは、レスポンスのステータスコードに応じて適切なメッセージを表示します。

これにより、リクエストの結果を簡単に把握できます。

応用例

APIを利用することで、さまざまなアプリケーションを作成することができます。

ここでは、具体的な応用例として、天気情報API、為替レートAPI、SNS API、地図APIを使ったアプリケーションの作成方法を紹介します。

天気情報APIを使った天気予報アプリの作成

天気情報APIを利用して、指定した地域の天気予報を取得するアプリケーションを作成します。

以下は、OpenWeatherMap APIを使用した例です。

import requests
API_KEY = 'YOUR_API_KEY'
city = 'Tokyo'
url = f'http://api.openweathermap.org/data/2.5/weather?q={city}&appid={API_KEY}&units=metric'
response = requests.get(url)
data = response.json()
if response.status_code == 200:
    print(f"{city}の天気: {data['weather'][0]['description']}")
    print(f"気温: {data['main']['temp']}°C")
else:
    print("天気情報を取得できませんでした。")

このコードでは、指定した都市の天気情報を取得し、天気の説明と気温を表示します。

為替レートAPIを使った通貨換算ツールの作成

為替レートAPIを利用して、異なる通貨間の換算を行うツールを作成します。

以下は、ExchangeRate APIを使用した例です。

import requests
API_KEY = 'YOUR_API_KEY'
base_currency = 'USD'
target_currency = 'JPY'
url = f'https://api.exchangerate-api.com/v4/latest/{base_currency}'
response = requests.get(url)
data = response.json()
if response.status_code == 200:
    rate = data['rates'][target_currency]
    amount = 100  # 換算する金額
    converted_amount = amount * rate
    print(f"{amount} {base_currency} は {converted_amount:.2f} {target_currency} です。")
else:
    print("為替レートを取得できませんでした。")

このコードでは、指定した通貨の為替レートを取得し、100ドルを日本円に換算します。

SNS APIを使った投稿の自動化

SNS APIを利用して、自動的に投稿を行うアプリケーションを作成します。

以下は、Twitter APIを使用した例です。

import tweepy
API_KEY = 'YOUR_API_KEY'
API_SECRET_KEY = 'YOUR_API_SECRET_KEY'
ACCESS_TOKEN = 'YOUR_ACCESS_TOKEN'
ACCESS_TOKEN_SECRET = 'YOUR_ACCESS_TOKEN_SECRET'
auth = tweepy.OAuth1UserHandler(API_KEY, API_SECRET_KEY, ACCESS_TOKEN, ACCESS_TOKEN_SECRET)
api = tweepy.API(auth)
tweet = "こんにちは、世界！自動投稿テストです。"
api.update_status(tweet)
print("ツイートが投稿されました。")

このコードでは、Twitterに自動的にツイートを投稿します。

APIキーやトークンは、Twitter Developer Portalから取得できます。

地図APIを使った位置情報サービスの作成

地図APIを利用して、指定した地点の地図を表示するアプリケーションを作成します。

以下は、Google Maps APIを使用した例です。

import requests
API_KEY = 'YOUR_API_KEY'
latitude = 35.6895  # 緯度
longitude = 139.6917  # 経度
url = f'https://maps.googleapis.com/maps/api/staticmap?center={latitude},{longitude}&zoom=14&size=600x300&key={API_KEY}'
response = requests.get(url)
if response.status_code == 200:
    with open('map.png', 'wb') as f:
        f.write(response.content)
    print("地図が保存されました。")
else:
    print("地図を取得できませんでした。")