J-Quants Client

JPXが提供する個人投資家向けAPIであるJ-QuantsへアクセスするためのJavaScript/TypeScriptのクライアントライブラリです。 OpenAPI Specificationから自動生成された型安全なクライアントを提供します。

特徴

• OpenAPI SpecificationからKiotaを使用して自動生成された型安全なクライアント
• 型安全なAPI呼び出し

セットアップ

前提

J-Quants APIを利用するには、事前にJ-Quants APIのユーザー登録が必要です。

インストール

# Deno
deno add jsr:@fuji44/jquants-client

# Node.js
npx jsr add @fuji44/jquants-client

使用方法

import {
  BaseBearerTokenAuthenticationProvider,
  createJQuantsClient,
  FetchRequestAdapter,
  JQuantsIDTokenProvider,
} from "jquants-client";

const client = createJQuantsClient(
  new FetchRequestAdapter(
    new BaseBearerTokenAuthenticationProvider(
      new JQuantsIDTokenProvider(
        "your-mail-address",
        "your-password",
      ),
    ),
  ),
);

const resp = await client.listed.info.get({
  queryParameters: { code: "86970" },
});

console.log(resp.info);
// [ { code: "86970", companyName: "日本取引所グループ", ... } ]

API仕様書

OpenAPI仕様書は spec/jquants-v2.oas.yaml にあります。 以下のコマンドで、WebブラウザでOpenAPI仕様書を表示できます。

deno task api-doc:preview

開発

開発環境のセットアップやワークフローについては 開発ガイド を参照してください。