【プログラミング】ChatGPTと進めるAPI活用方法と実践

前回の記事「ChatGPTとPythonで学ぶ！APIを使った高度なデータ収集と自動化」では、APIの基礎について学びました。今回の記事では、さらに一歩進んで、Hacker News APIを使いながら、具体的なAPIリクエストの送信方法やデータ取得のプロセスを実践していきます。また、取得したデータをプログラム内でフィルタリングする方法も取り上げ、APIの活用術をより深く理解できる内容をお届けします。これを機に、実際のプロジェクトでAPIを使いこなせるスキルを身につけていきましょう。

Pythonの始め方についてはこちらの記事を参考にしてみてください！！

参考記事

: 【初心者必見】ChatGPTで始めるPythonプログラミング入門
プログラミングを始めたいと思っているけど、プログラミングって何から始めたらいいかわからないし、プログラムを書くのは英語もできないから難しそうと思っているあなたに朗報です。ChatGPTを使って学習をす ...

ブログ内のコードはコピーして使用できます

APIとは何か？

APIは「Application Programming Interface」の略です。簡単に言うと、APIはコンピュータプログラム同士が話すためのルールです。

APIをカフェでの注文に例えてみましょう

あなた（ユーザー）: レストランのお客さん
キッチン（サービス）: 食べ物を作る場所
ウェイター（API）: あなたとキッチンをつなぐ人

レストランで食事を注文する時、あなたはウェイターに「パスタをください」と伝えます。ウェイターはそのメッセージをキッチンに伝え、キッチンでパスタが作られます。パスタができたら、ウェイターはそれをあなたに届けます。

APIはこの「ウェイター」のような役割を果たします。

あなた（プログラム）はAPIを通じて他のプログラム（サービス）に何かをお願いしたり、情報を取り出したりします。
APIはそのお願いを受け取って、必要な情報を持ってきたり、指示を実行したりします。

ステップ1: 基本的なAPIリクエストの送信とデータ取得

まずは、Hacker News APIからデータを取得するシンプルなリクエストを送信してみましょう。以下のコードは、Hacker NewsのトップストーリーのIDリストを取得するものです。

今回使用するAPI

サイト：Free Weather API

APIはこちらから→GitHub‐Free Weather API

APIリクエストの送信とデータ取得

import requests

# Hacker News APIのトップストーリーのエンドポイント
top_stories_url = 'https://hacker-news.firebaseio.com/v0/topstories.json'

# APIリクエストを送信してデータを取得
response = requests.get(top_stories_url)

# レスポンスからJSONデータを取得
story_ids = response.json()

# 取得したトップストーリーのIDを表示
print("トップストーリーのIDリスト:")
print(story_ids[:10])  # 最初の10個のIDを表示

import requests

# Hacker News APIのトップストーリーのエンドポイント

top_stories_url = 'https://hacker-news.firebaseio.com/v0/topstories.json'

# APIリクエストを送信してデータを取得

response = requests.get(top_stories_url)

# レスポンスからJSONデータを取得

story_ids = response.json()

# 取得したトップストーリーのIDを表示

print("トップストーリーのIDリスト:")

print(story_ids[:10]) # 最初の10個のIDを表示

ポイント

requests.get(): 指定したURLに対してHTTP GETリクエストを送信します。
response.json(): レスポンスをJSON形式で取得します。JSON形式は、構造化されたデータを扱う際に非常に便利です。
story_ids[:10]: トップストーリーのIDリストから最初の10件を表示します。

出力

トップストーリーのIDリスト:
[41338877, 41339308, 41310319, 41338776, 41339818, 41341353, 41337356, 41340948, 41339493, 41339885]

1 2	トップストーリーのIDリスト: [41338877, 41339308, 41310319, 41338776, 41339818, 41341353, 41337356, 41340948, 41339493, 41339885]

ダダ

何か数字が出力されたことがわかりますが、この数字が何なのかわかりませんよね！！
https://hacker-news.firebaseio.com/v0/topstories.json
コードに入力しているサイトに行ってみましょう。

ダダ

上記の画像のような数字が書かれた画面が出て来ます。
この最初にある10個のIDを表示するコードとなっています。

トップストーリーのIDリスト

「トップストーリーのIDリスト」とは、主にニュースやウェブサイトで特定の記事やコンテンツを識別するために使われるIDのリストのことを指します。ニュースサイトやコンテンツ配信プラットフォームでは、各記事やストーリーに一意のIDが割り当てられています。このIDを使用することで、記事を簡単に検索、参照、または管理することができます。

ステップ2: 特定のデータを取得

次に、取得したストーリーIDの中から、1つのストーリーの詳細を取得してみましょう。

# 取得した最初のストーリーIDを使用して、ストーリーの詳細を取得
story_id = story_ids[0]
story_url = f'https://hacker-news.firebaseio.com/v0/item/{story_id}.json'

# APIリクエストを送信して、特定のストーリーのデータを取得
story_response = requests.get(story_url)
story_data = story_response.json()

# ストーリーの詳細を表示
print("\nストーリーの詳細:")
print(f"タイトル: {story_data['title']}")
print(f"URL: {story_data.get('url', 'URLなし')}")
print(f"スコア: {story_data['score']}")
print(f"コメント数: {story_data['descendants']}")

# 取得した最初のストーリーIDを使用して、ストーリーの詳細を取得

story_id = story_ids[0]

story_url = f'https://hacker-news.firebaseio.com/v0/item/{story_id}.json'

# APIリクエストを送信して、特定のストーリーのデータを取得

story_response = requests.get(story_url)

story_data = story_response.json()

# ストーリーの詳細を表示

print("\nストーリーの詳細:")

print(f"タイトル: {story_data['title']}")

print(f"URL: {story_data.get('url', 'URLなし')}")

print(f"スコア: {story_data['score']}")

print(f"コメント数: {story_data['descendants']}")

ポイント

story_id: トップストーリーIDのリストから1つのIDを選びます。
story_url: 選んだIDを使って、そのストーリーの詳細情報を取得するURLを作成します。
story_response.json(): ストーリーの詳細データをJSON形式で取得します。
story_data: ストーリーのタイトル、URL、スコア、コメント数などの詳細を表示します。

出力

ストーリーの詳細:
タイトル: Pipe Syntax in SQL
URL: https://research.google/pubs/sql-has-problems-we-can-fix-them-pipe-syntax-in-sql/
スコア: 168
コメント数: 125

ストーリーの詳細:

タイトル: Pipe Syntax in SQL

URL: https://research.google/pubs/sql-has-problems-we-can-fix-them-pipe-syntax-in-sql/

スコア: 168

コメント数: 125

URLを検索してみると以下のようなサイトに飛びました
https://research.google/pubs/sql-has-problems-we-can-fix-them-pipe-syntax-in-sql/

ダダ

なんだかAPIを活用できてる感が出てきてワクワクしております🤭

ステップ3: リクエストパラメータを使ったデータのフィルタリング

Hacker News API自体は、リクエストパラメータによるフィルタリング機能が限られていますが、取得したデータをプログラム内でフィルタリングすることが可能です。例えば、スコアが一定以上のストーリーだけを表示するフィルタリングを行います。

# スコアが100以上のストーリーのみ表示する
min_score = 100

for story_id in story_ids[:10]:
    story_url = f'https://hacker-news.firebaseio.com/v0/item/{story_id}.json'
    story_response = requests.get(story_url)
    story_data = story_response.json()
    
    if story_data['score'] >= min_score:
        print("\nフィルタリングされたストーリー:")
        print(f"タイトル: {story_data['title']}")
        print(f"スコア: {story_data['score']}")

# スコアが100以上のストーリーのみ表示する

min_score = 100

for story_id in story_ids[:10]:

story_url = f'https://hacker-news.firebaseio.com/v0/item/{story_id}.json'

story_response = requests.get(story_url)

story_data = story_response.json()

if story_data['score'] >= min_score:

print("\nフィルタリングされたストーリー:")

print(f"タイトル: {story_data['title']}")

print(f"スコア: {story_data['score']}")

ポイント

min_score: スコアの最低基準値を設定します。この例では、スコアが100以上のストーリーだけを表示します。
if story_data['score'] >= min_score: 取得したストーリーのスコアが基準値以上かをチェックし、条件を満たす場合のみそのストーリーを表示します。

出力

フィルタリングされたストーリー:
タイトル: Pipe Syntax in SQL
スコア: 168

フィルタリングされたストーリー:
タイトル: Small Strings in Rust: smolstr vs. smartstring
スコア: 101

フィルタリングされたストーリー:
タイトル: Hot Page – a graphical site builder
スコア: 271

フィルタリングされたストーリー:
タイトル: JavaScript dates are about to be fixed
スコア: 232

フィルタリングされたストーリー:
タイトル: NASA Decides to Bring Starliner Spacecraft Back to Earth Without Crew
スコア: 126

フィルタリングされたストーリー:

タイトル: Pipe Syntax in SQL

スコア: 168

フィルタリングされたストーリー:

タイトル: Small Strings in Rust: smolstr vs. smartstring

スコア: 101

フィルタリングされたストーリー:

タイトル: Hot Page – a graphical site builder

スコア: 271

フィルタリングされたストーリー:

タイトル: JavaScript dates are about to be fixed

スコア: 232

フィルタリングされたストーリー:

タイトル: NASA Decides to Bring Starliner Spacecraft Back to Earth Without Crew

スコア: 126

スコアについて

Hacker News（HN）での「スコア」とは、特定のストーリー（記事や投稿）に対してユーザーが付けた「アップボート（Upvote）」の合計数を指します。Hacker Newsでは、ユーザーが気に入ったり、価値があると感じた投稿に「アップボート」をすることで、ストーリーのスコアが上昇します。

スコアが高いストーリーは、より多くのユーザーに支持され、価値があると見なされていることを意味します。そのため、Hacker Newsのトップページやその他のリストには、スコアの高いストーリーが優先的に表示されることが多いです。

プログラム内でスコアを基準にフィルタリングすることで、例えばスコアが一定以上（たとえば100以上）に達したストーリーのみを抽出して表示することができます。これは、より質の高い、もしくはユーザーに人気のあるコンテンツのみを扱いたい場合に便利です。

ダダ

データのフィルタリングを行うことで、人気のあるコンテンツのみを収集することができます。

ステップ4: 複数のストーリーを一括で処理する

1つのストーリーについて詳細情報を取得しましたが、複数のストーリーを一括で処理し、その中から条件に合致するデータをフィルタリングする方法を学びます。

複数のストーリーを一括で取得して処理するコード

import requests

# Hacker News APIのトップストーリーのエンドポイント
top_stories_url = 'https://hacker-news.firebaseio.com/v0/topstories.json'

# APIリクエストを送信してデータを取得
response = requests.get(top_stories_url)
story_ids = response.json()

# スコアが100以上のストーリーをリストに追加
filtered_stories = []

for story_id in story_ids[:10]:  # ここでは最初の10件を処理
    story_url = f'https://hacker-news.firebaseio.com/v0/item/{story_id}.json'
    story_response = requests.get(story_url)
    story_data = story_response.json()
    
    if story_data['score'] >= 100:  # スコアが100以上のストーリーをフィルタリング
        filtered_stories.append({
            'title': story_data['title'],
            'score': story_data['score'],
            'url': story_data.get('url', 'URLなし')
        })

# フィルタリングされたストーリーを表示
print("\nフィルタリングされたストーリー:")
for story in filtered_stories:
    print(f"タイトル: {story['title']}, スコア: {story['score']}, URL: {story['url']}")

import requests

# Hacker News APIのトップストーリーのエンドポイント

top_stories_url = 'https://hacker-news.firebaseio.com/v0/topstories.json'

# APIリクエストを送信してデータを取得

response = requests.get(top_stories_url)

story_ids = response.json()

# スコアが100以上のストーリーをリストに追加

filtered_stories = []

for story_id in story_ids[:10]: # ここでは最初の10件を処理

story_url = f'https://hacker-news.firebaseio.com/v0/item/{story_id}.json'

story_response = requests.get(story_url)

story_data = story_response.json()

if story_data['score'] >= 100: # スコアが100以上のストーリーをフィルタリング

filtered_stories.append({

'title': story_data['title'],

'score': story_data['score'],

'url': story_data.get('url', 'URLなし')

})

# フィルタリングされたストーリーを表示

print("\nフィルタリングされたストーリー:")

for story in filtered_stories:

print(f"タイトル: {story['title']}, スコア: {story['score']}, URL: {story['url']}")

ポイント

filtered_stories: スコアが100以上のストーリーだけを格納するリストです。
story_ids[:10]: 最初の10件のストーリーIDについて処理を行います。この範囲を調整することで、処理するストーリーの数を変えることができます。
filtered_stories.append({...}): 条件を満たすストーリーの情報（タイトル、スコア、URL）をリストに追加します。

出力

フィルタリングされたストーリー:
タイトル: Ask HN: What are you working on (August 2024)?, スコア: 220, URL: URLなし
タイトル: Defenders think in lists, attackers think in graphs (2015), スコア: 123, URL: https://github.com/JohnLaTwC/Shared/blob/master/Defenders%20think%20in%20lists.%20Attackers%20think%20in%20graphs.%20As%20long%20as%20this%20is%20true%2C%20attackers%20win.md
タイトル: You are not dumb, you just lack the prerequisites, スコア: 274, URL: https://lelouch.dev/blog/you-are-probably-not-dumb/

フィルタリングされたストーリー:

タイトル: Ask HN: What are you working on (August 2024)?, スコア: 220, URL: URLなし

タイトル: Defenders think in lists, attackers think in graphs (2015), スコア: 123, URL: https://github.com/JohnLaTwC/Shared/blob/master/Defenders%20think%20in%20lists.%20Attackers%20think%20in%20graphs.%20As%20long%20as%20this%20is%20true%2C%20attackers%20win.md

タイトル: You are not dumb, you just lack the prerequisites, スコア: 274, URL: https://lelouch.dev/blog/you-are-probably-not-dumb/

ポイント

コードの内のデータを変更してみよう

# ここでは最初の10件を処理<br># スコアが100以上のストーリーをフィルタリング

1	# ここでは最初の10件を処理<br># スコアが100以上のストーリーをフィルタリング

上記の数値を変更することで、出力されるデータが変更されます。

ステップ5: データの保存

次に、フィルタリングされたデータをファイルに保存する方法を学びます。JSONファイルに保存することで、後でデータを再利用したり、他のプログラムで読み込むことが容易になります。

データをJSONファイルに保存するコード

import json

# フィルタリングされたストーリーをファイルに保存
with open('filtered_stories.json', 'w', encoding='utf-8') as file:
    json.dump(filtered_stories, file, ensure_ascii=False, indent=2)

print("フィルタリングされたデータが 'filtered_stories.json' に保存されました。")

import json

# フィルタリングされたストーリーをファイルに保存

with open('filtered_stories.json', 'w', encoding='utf-8') as file:

json.dump(filtered_stories, file, ensure_ascii=False, indent=2)

print("フィルタリングされたデータが 'filtered_stories.json' に保存されました。")

ポイント

json.dump: Pythonのリストや辞書をJSON形式でファイルに保存します。
ensure_ascii=False: 日本語などの非ASCII文字をそのまま保存するためのオプションです。
indent=2: 保存するJSONファイルのインデント（字下げ）を設定します。読みやすい形式で保存されます。

出力

このコード単独では、ファイルに保存するデータがないのでエラーが出てきます。

ステップ6: 実行と確認

上記のコードをステップ5のこーどにいれて実行し、filtered_stories.jsonというファイルにフィルタリングされたストーリーのデータが保存されることを確認しましょう。このファイルには、スコアが100以上のトップストーリーが含まれています。

import requests
import json


# Hacker News APIのトップストーリーのエンドポイント
top_stories_url = 'https://hacker-news.firebaseio.com/v0/topstories.json'

# APIリクエストを送信してデータを取得
response = requests.get(top_stories_url)
story_ids = response.json()

# スコアが100以上のストーリーをリストに追加
filtered_stories = []

for story_id in story_ids[:10]:  # ここでは最初の10件を処理
    story_url = f'https://hacker-news.firebaseio.com/v0/item/{story_id}.json'
    story_response = requests.get(story_url)
    story_data = story_response.json()
    
    if story_data['score'] >= 50:  # スコアが100以上のストーリーをフィルタリング
        filtered_stories.append({
            'title': story_data['title'],
            'score': story_data['score'],
            'url': story_data.get('url', 'URLなし')
        })

# フィルタリングされたストーリーを表示
print("\nフィルタリングされたストーリー:")
for story in filtered_stories:
    print(f"タイトル: {story['title']}, スコア: {story['score']}, URL: {story['url']}")

# フィルタリングされたストーリーをファイルに保存
with open('filtered_stories.json', 'w', encoding='utf-8') as file:
    json.dump(filtered_stories, file, ensure_ascii=False, indent=2)

print("フィルタリングされたデータが 'filtered_stories.json' に保存されました。")

import requests

import json

# Hacker News APIのトップストーリーのエンドポイント

top_stories_url = 'https://hacker-news.firebaseio.com/v0/topstories.json'

# APIリクエストを送信してデータを取得

response = requests.get(top_stories_url)

story_ids = response.json()

# スコアが100以上のストーリーをリストに追加

filtered_stories = []

for story_id in story_ids[:10]: # ここでは最初の10件を処理

story_url = f'https://hacker-news.firebaseio.com/v0/item/{story_id}.json'

story_response = requests.get(story_url)

story_data = story_response.json()

if story_data['score'] >= 50: # スコアが100以上のストーリーをフィルタリング

filtered_stories.append({

'title': story_data['title'],

'score': story_data['score'],

'url': story_data.get('url', 'URLなし')

})

# フィルタリングされたストーリーを表示

print("\nフィルタリングされたストーリー:")

for story in filtered_stories:

print(f"タイトル: {story['title']}, スコア: {story['score']}, URL: {story['url']}")

# フィルタリングされたストーリーをファイルに保存

with open('filtered_stories.json', 'w', encoding='utf-8') as file:

json.dump(filtered_stories, file, ensure_ascii=False, indent=2)

print("フィルタリングされたデータが 'filtered_stories.json' に保存されました。")

ポイント

・import jsonを2行目に追加します。
・ステップ6で作成したコードをステップ5で作成したコードの後に追加したします。

出力

フィルタリングされたストーリー:
タイトル: Ask HN: What are you working on (August 2024)?, スコア: 228, URL: URLなし
タイトル: Defenders think in lists, attackers think in graphs (2015), スコア: 127, URL: https://github.com/JohnLaTwC/Shared/blob/master/Defenders%20think%20in%20lists.%20Attackers%20think%20in%20graphs.%20As%20long%20as%20this%20is%20true%2C%20attackers%20win.md
フィルタリングされたデータが 'filtered_stories.json' に保存されました。

フィルタリングされたストーリー:

タイトル: Ask HN: What are you working on (August 2024)?, スコア: 228, URL: URLなし

タイトル: Defenders think in lists, attackers think in graphs (2015), スコア: 127, URL: https://github.com/JohnLaTwC/Shared/blob/master/Defenders%20think%20in%20lists.%20Attackers%20think%20in%20graphs.%20As%20long%20as%20this%20is%20true%2C%20attackers%20win.md

フィルタリングされたデータが 'filtered_stories.json' に保存されました。

JSONファイルの作成

まとめ

今回の記事では、Hacker News APIを使って、具体的なAPIリクエストの送信方法やデータ取得のプロセスを学びました。特に、取得したデータをプログラム内でフィルタリングする方法や、フィルタリングされたデータをJSONファイルに保存する手法についても詳しく解説しました。

主なポイントは以下の通りです:

APIとは何か？
- APIは、異なるプログラム間でデータや機能をやり取りするためのインターフェースです。カフェでの注文を例に挙げて、APIの役割を理解しました。
Hacker News APIからデータを取得する方法
- Pythonのrequestsライブラリを使って、APIリクエストを送信し、トップストーリーのIDリストを取得しました。
特定のデータを取得する方法
- 取得したIDの中から、特定のストーリーの詳細を取得し、そのデータを表示しました。
データのフィルタリング
- スコアが100以上のストーリーだけをフィルタリングして表示する方法を学びました。これは、より価値のあるデータに絞り込みたい場合に有効です。
フィルタリングされたデータの保存
- フィルタリングされたストーリーのデータをJSON形式で保存する方法を紹介しました。保存されたデータは、後で再利用したり、他のプログラムで読み込むことができます。

これで、APIを使ったデータ収集と処理の基本的な流れを理解できたと思います。実際のプロジェクトに応用して、APIを使いこなすスキルをさらに磨いていきましょう。次回の記事では、さらに高度なAPI活用法や自動化の技術について取り上げる予定ですので、ぜひお楽しみに！

次回の記事

: ChatGPTとPythonで学ぶ！APIを使った高度なデータ収集と自動化
APIの活用は、プログラミングにおいて重要なスキルの一つです。前回の記事「【プログラミング】ChatGPTと進めるAPI学習の基本」では、APIの基礎について学びました。今回は、さらに一歩進んで、Ch ...

もしわからないことがあれば、このブログやXに質問等を投げていただければと思います。また、コミュニティもやっっているのでそちらから質問を投げていただいても大丈夫ですよ！！

Xのアカウントはこちら

ダダのアカウント

Discordコミュニティ

ハピッツカフェ

プログラミングを視覚的に理解したい方やプログラミングで絵を書いてみたい方はUdemyで講座も作っているのでこちらも参考にしてみてください

Udemy講座

Processing Python講座

ChatGPTでPythonの学習を始めてみたい方は以下の記事を参考にしてみてください

: プログラミング完全ガイド：基礎からスクレイピング＆API活用までのまとめ
プログラミングの世界に足を踏み入れたばかりの初心者から、さらなるスキルアップを目指す中級者まで、すべての方に向けた完全ガイドです！この記事では、これまでに執筆したプログラミング関連の記事をまとめ、プロ ...

ChatGPTはプログラミングの学習はできても、人のつながりまでは作ってくれません。
プログラミングの学習だけではなく、人との繋がりを作ってくれるスクールもオススメです。
気になる方は無料相談からでも体験してみてください！！

テックアカデミー無料メンター相談

【プログラミング】ChatGPTと進めるAPI活用方法と実践

APIとは何か？

APIをカフェでの注文に例えてみましょう

ステップ1: 基本的なAPIリクエストの送信とデータ取得

出力

ステップ2: 特定のデータを取得

出力

ステップ3: リクエストパラメータを使ったデータのフィルタリング

出力

ステップ4: 複数のストーリーを一括で処理する

出力

ステップ5: データの保存

出力

ステップ6: 実行と確認

出力

まとめ

関連