Era API

エージェントを承認するとキーが一つ作られます

OAuthでエージェントを承認すると、EraはそのためのAPIキーを作ります。自分で作ったキーと同じダッシュボードの一覧に、クライアント自身の名前からEraが組み立てた名前で並びます。

その画面で承認したスコープをそのまま持ち、それ以外は持ちません。ダッシュボードから失効させると、再度承認するまでエージェントは新しいアクセス権を得られません。すでに持っているトークンは有効期限まで使え、その期限は最長1時間です。

書き込みはアクティビティログに残り、読み取りは残りません

キーの作成と失効はどちらもアクティビティログに残り、エージェントがMCPで行うツール呼び出しもすべて残ります。RESTの書き込みも残ります——タグを作成した、取引を編集したといった変更として記録されます。RESTの読み取りはエントリを一切作りません。これらのエントリはどのプランでも記録されますが、ログ全体を読むにはOrganize以上が必要です。それ未満では直近のエントリだけが見えます。書き込みのエントリに記録されるのはアカウントで、変更を行ったキーではありません。

キーに不安を感じたら、失効させてください。自分で作成したキーは、次のリクエストからRESTとMCPの両方で使えなくなります。エージェントのキーはただちに新しいアクセス権を得られなくなり、すでに持っているトークンも1時間以内に失効します。作り直しにかかるのは1分です。

接続済みの金融機関をまたいで、見えている口座をすべて返します。外してある口座の件数も一緒に付きます。その件数がexcludedAccountCountで、プランの口座数上限で外れているtierExcludedAccountCountと、自分で隠したuserExcludedAccountCountに分かれています。accountLimitは、すべての接続を合わせてプランが一度に表示できる口座数です。accountLimitLiftは隠していない口座がすべて収まる一番安いプランの名前で、プランで外れている口座がないときはnullです。どの口座にも、残高のエンドポイントがパスで受け取る値であるaccountGroupKeyと、その口座が属するconnectionIdが入っているので、まずはこの呼び出しから始めてください。connectionIdで一つの接続に絞り込め（件数は一緒に絞り込まれますが、accountLimitとaccountLimitLiftは変わりません）、includeExcludedでプランで外れている口座と自分が隠した口座も含められます。

{
  "accounts": [
    {
      "accountGroupKey": "uagr_7f3c9a21",
      "connectionId": "ucon_4b19e02c",
      "name": "Everyday Checking",
      "currentBalance": 4820.16,
      "supportsTransactions": true,
      …
    }
  ],
  "excludedAccountCount": 1
}

自分が隠した口座や、プランの対象外になっている口座では、残高のフィールドはゼロではなくnullで返ります。nullは「空」ではなく「伏せてある」という意味です。supportsTransactionsのnullも同じ考え方で、Eraには言えないという意味であって、答えが「いいえ」だという意味では決してありません。プラン関連のフィールドも同じです。その呼び出しでEraがプランを読み取れなかった場合、tierExcludedAccountCount、userExcludedAccountCount、accountLimit、accountLimitLiftはすべてnullで返ります。口座数に上限のないプランではaccountLimitもnullになり、これ以上余裕のあるプランがない場合や、プランで外れている口座がない場合はaccountLimitLiftがnullになります。

One account's balance, with the credit fields filled in when the account is a liability. The path takes that account's accountGroupKey — the same value /banking/accounts returns for it. The key is not checked for shape before the lookup, so a malformed key and an unknown one answer the same way.

{
  "accountGroupKey": "uagr_7f3c9a21",
  "currentBalance": 4820.16,
  "availableBalance": 4712.03,
  "creditLimit": null,
  "currencyCode": "USD",
  "availableCredit": null,
  "asOf": "2026-08-11T09:32:00Z",
  "visibility": null
}

隠した口座も、接続が切れた口座も、返ってくるのは200のままで、残高のフィールドがnullになります。404は、その口座が本当に存在しないか、キーがキーの形をしていなかったことを意味します。ここではvisibilityのフィールドに注意してください。口座が見えているときはnull、プランの口座数上限で外れているときはtier_excluded、自分で隠したときはuser_excluded、接続が切れたときはconnection_severedが入ります。tier_excludedのときは、accountLimitがプランの上限で、accountLimitLiftがこの口座を含め隠していない口座がすべて収まる一番安いプランの名前です。それ以外の状態ではaccountLimitLiftはnullで、connection_severedのときはaccountLimitもnullです。

見えている口座の合計です。標準ではライブ口座が対象で、totalAssets、totalLiabilities、そして前者から後者を引いたnetWorthHintが入ります。simulationModesを渡すと、どのモードを数えるかを選べます。口座の一覧と合計は、指定したモードだけを対象にします。どのモードを対象にしたかはincludedSimulationModesが毎回のレスポンスで示します。simulationExcludedAccountCountは、モードのせいで除外された、見える口座の数です。totalHiddenCountは別の数で、プランやご自身の表示設定で非表示になっている口座をどのモードでも数え、simulationModesで除外された口座は含みません。

{
  "userId": "7d1c0b93a8e24f60",
  "accounts": [ … ],
  "totalVisibleCount": 6,
  "totalHiddenCount": 2,
  "totalAssets": 48210.75,
  "totalLiabilities": 9327.40,
  "netWorthHint": 38883.35,
  "includedSimulationModes": [ "live" ],
  "simulationExcludedAccountCount": 0,
  "computedAt": "2026-08-11T09:32:00Z"
}

netWorthHintが数えるのはこのレスポンスに入っている口座だけで、外れているものは2つの数でわかります。simulationExcludedAccountCountは、指定したモード以外の口座の数です。totalHiddenCountは、どのモードでも非表示になっている口座の数です。内訳は2つで、tierExcludedAccountCountはプランの口座数上限で外れている口座、userExcludedAccountCountは自分で隠した口座です。その呼び出しでEraがプランを読み取れなかった場合、どちらもnullになります。accountLimitLiftは前者を戻せる一番安いプランの名前で、前者がないときはnullです。netWorthHintは確定した純資産ではなく、出発点の数字として扱ってください。

取引を1ページずつ、ページ数の情報と一緒に包んで返します。pageとpageSize（上限は100）を受け取り、口座、期間、適用済みルール、付与済みタグでの絞り込みも指定できます。

{
  "transactions": [ … ],
  "pagination": {
    "currentPage": 1,
    "pageSize": 20,
    "totalItems": 412,
    "totalPages": 21
  },
  "historyWindowApplied": true,
  "historyWindowFloorDate": "2026-06-28",
  "historyWindowHiddenCount": 137,
  "historyWindowEarliestDate": "2024-03-02",
  "historyWindowDegraded": false
}

プランによっては履歴ウィンドウの境目が適用され、それより古い取引は隠れます。レスポンスにhistoryWindowのフィールドが並んでいるのはそのためです。historyWindowAppliedは境目が実際に何かを隠したことを示し、historyWindowFloorDateはその境目の位置、historyWindowHiddenCountは後ろに何件あるか、historyWindowEarliestDateは履歴が実際にどこまで遡れるかを示します。これがないと、件数が少ない結果は「それ以上古い取引がない口座」と見分けがつきません。このうち二つは書くコードを左右します。historyWindowHiddenCountは境目が適用されていてもnullになることがあるので、nullはゼロではなく「不明」として読んでください。historyWindowDegradedがtrueのときは、その読み取りでEraがプランを確認できていないため、境目の日付は事実ではなく推測です。プランを確認できた有料の読み取りでは境目は適用されず、historyWindowAppliedはfalseで返ります。プランの口座数上限でも取引は外れます。tierExcludedAccountCountはこの読み取りから上限で外れている口座の数、userExcludedAccountCountは自分で隠した口座の数で、口座で絞り込んだ場合はどちらもその口座だけを数えます。その呼び出しでEraがプランを読み取れなかった場合は、どちらもnullです。

長い履歴をページ送りで読むと、リクエストを消費します。プランは呼び出せる速さを制限し、無料プランでは1日に使える呼び出し数も制限します。有料プランはフェアユースの範囲でご利用いただけます。プランごとの数値、レート制限ヘッダー、そして429が伝えることは、制限の節にまとめています。

カテゴリ体系のすべて。カテゴリのまとまりごとに、その下位カテゴリが入れ子で入ります。この体系は共通で、口座ごとではありません。

{
  "packs": [
    {
      "packSlug": "default",
      "packName": "Era default categories",
      "isDefault": true,
      "categories": [
        {
          "projectionKey": "fcat_food_dining",
          "categoryName": "Food & dining",
          "isTopLevel": true,
          "children": [ … ]
        }
      ]
    }
  ],
  "meterLimit": 25,
  "canCreateCustomCategories": true
}

アカウントのタグをすべて、ひとつのリストで返します。ページ分割はありません。1回のレスポンスですべて返ります。

{
  "tags": [
    {
      "tagKey": "utag_9c2f01ab",
      "name": "business-expense",
      "displayName": "Business expense",
      "tagType": "user",
      "color": "#6DC6BA",
      "transactionCount": 42
    }
  ]
}

アカウントのすべての自動化ルールです。自分で作ったものも、Eraがルールライブラリから設定したものも含み、それぞれに条件（filters）、実行する内容（actions）、オンかどうか、そしてバージョンが付きます。ページ分割はありません。1回のレスポンスですべて返ります。オフのルールは、指定しない限り含まれません。

{
  "rules": [
    {
      "id": "rule_4c1e7a90",
      "ruleName": "Coffee shops",
      "isActive": true,
      "version": 3,
      "priority": 10,
      "filters": [{ "type": "merchant_match", "pattern": "Blue Bottle", "mode": "contains" }],
      "actions": [{ "type": "set_category", "categoryKey": "fcat_coffee_shops", "categoryDisplayName": "Coffee shops" }],
      "source": "user",
      "matchedTransactionCount": 42,
      …
    }
  ]
}

filtersとactionsは、型付きオブジェクトのリストです。それぞれtypeフィールドで種類を示します——フィルターならmerchant_matchやcategory、アクションならset_categoryやadd_tagなど。すべての種類と、それぞれが受け取るフィールドは、クイックスタートからリンクしているOpenAPIドキュメントに載っています。