pyzaimflow

pyzaimflow は、株式会社くふうカンパニーホールディングスが運営するマネー・プラットフォーム「Zaim」からデータを取得・連携するための Python パッケージです。主に Zaim API のラッパー機能を提供し、今後は Web 画面のスクレイピング機能も追加予定です。

概要

pyzaimflow が提供する主な機能は次のとおりです。

• Zaim API を利用したデータの取得・登録・更新・削除
  • Zaim が提供する Web API を扱いやすくするラッパー機能を提供します。
  • Zaim の OAuth 1.0a 認証を支援する CLI を提供します（今後提供予定）。
• Zaim の Web 画面をスクレイピングして、API では取得できないデータを収集します（今後提供予定）。
  • たとえば、銀行／クレジットカードの明細など、API では取得できない情報を補完します。

パッケージが提供する API 一覧

API の一覧と詳細は、GitHub の Wiki を参照してください。

推奨環境

• Python 3.10.12 以上

事前準備

くふう.Zaim にアクセスして Zaim のアカウントを作成してください。アカウントの作成方法については、リンク先を参照してください。本ドキュメントでは、アカウント作成手順については省略します。

インストール

pip install pyzaimflow

パッケージの使い方

Zaim API を呼び出すには、コンシューマ ID とコンシューマシークレットが必要です。取得方法については、GitHub の Wiki を参照してください。

以下のコード例では、取得したコンシューマ ID とコンシューマシークレットを使って OAuth 認証フローを開始し、アクセストークンとアクセストークンシークレットを生成する方法を示します。

from pyzaimflow import OAuthConfig, OAuthFlow

# OAuthConfig を作成
config = OAuthConfig(
    "コンシューマ ID",
    "コンシューマシークレット",
)

# OAuth 認証フローを初期化
flow = OAuthFlow(config)

# OAuth 認証フローを開始
flow.start()

# 出力した認可 URL にアクセスし、Zaim の認証画面で「ログインして許可する」ボタンをクリックしてください。「認証が完了」画面に遷移し、画面に検証コードが表示されます。表示された検証コードをコピーして、ターミナルに貼り付けてください。
print("認可 URL:", flow.authorize_url())

verifier = input("検証コードを入力してください: ")

access = flow.complete(verifier)

print("アクセストークン:", access.oauth_token)
print("アクセストークンシークレット:", access.oauth_token_secret)

Zaim API を呼び出すには、上記のコード例で取得したアクセストークンとアクセストークンシークレットを使って、pyzaimflow の API クライアントを初期化してください。

from pyzaimflow import ZaimApi, ZaimConfig

# ZaimConfig を作成
zaim_config = ZaimConfig(
    "コンシューマ ID",
    "コンシューマシークレット",
    "アクセストークン",
    "アクセストークンシークレット",
)

# ZaimApi を初期化
zaim_api = ZaimApi(zaim_config)

# たとえば、2026年1月1日の家計簿の記録を取得する場合は、以下のようにします。
money = zaim_api.list_money(
    start_date="2026-01-01",
    end_date="2026-01-01",
)

# 取得した家計簿の記録を出力する場合は、以下のようにします。
print(money)