メインコンテンツへ移動
QuantanSite

APIリファレンス

APIドキュメント

このサイトが表示するのと同じ市場データを扱う読み取り専用のJSON APIです。成功レスポンスは { data, meta } エンベロープを使い、失敗時は { error: { code, message } } を使います。

ベースURL
http://localhost:3000
メソッド
GETのみ
フォーマット
JSON、UTF-8
レート制限
IPアドレスとエンドポイントごとに 60 秒あたり 60 リクエスト

These are API examples. This site is served as static files.

デモ
サーバーが MARKET_DATA_PROVIDER=fmp と FMP_API_KEY を設定していない限り、レスポンスは架空の銘柄を使った決定論的なデモデータセットから返されます。各レスポンスの meta.provider フィールドが、どのソースが応答したかを示します。

クオート一覧

GET/api/quotes

銘柄をフラットな配列として1ページ分返します。metaにはtotal、page、pageSizeが含まれます。以下のスクリーナーフィルターはすべてここでも機能します。解析できない値は無視されます。

パラメータ

パラメータ場所型必須説明
sectorquerystring任意正確なセクター名: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate。
sortquerystring任意並べ替えフィールド: marketCap(デフォルト)、price、changePercent、volume、symbol。
orderquerystring任意並べ替え順: desc(デフォルト)またはasc。
pagequerynumber任意ページ番号。1から始まります。
pageSizequerynumber任意1ページあたりの行数: デフォルトは20、最大100。

リクエスト

curl -s "http://localhost:3000/api/quotes?pageSize=3"

レスポンス例

200application/json

{
  "data": [
    {
      "symbol": "NWRB",
      "name": "Northwind Robotics",
      "exchange": "NASDAQ",
      "sector": "Technology",
      "industry": "Industrial Automation",
      "price": 733.8,
      "change": -16.52,
      "changePercent": -2.2,
      "previousClose": 750.32,
      "open": 750.03,
      "dayHigh": 751.29,
      "dayLow": 731.5,
      "volume": 3471317,
      "avgVolume": 2962633,
      "marketCap": 982258754565,
      "peRatio": 60.35,
      "eps": 12.16,
      "dividendYield": null,
      "week52High": 963.99,
      "week52Low": 583.89,
      "afterHoursPrice": 731,
      "afterHoursChangePercent": -0.38,
      "updatedAt": "2026-11-12T21:00:00.000Z"
    }
  ],
  "meta": {
    "provider": "demo",
    "generatedAt": "2026-11-12T21:00:04.512Z",
    "disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
    "total": 20,
    "page": 1,
    "pageSize": 3
  }
}

サンプルは1行に短縮しています。

クオートを取得

GET/api/quotes/{symbol}

1つの銘柄または指数の完全なクオートを返します。存在しないsymbolは404 not_foundを返します。

パラメータ

パラメータ場所型必須説明
symbolpathstring必須銘柄または指数のsymbol。例えば NWRB。大文字と小文字は区別されません。

リクエスト

curl -s "http://localhost:3000/api/quotes/NWRB"

レスポンス例

200application/json

{
  "data": {
    "symbol": "NWRB",
    "name": "Northwind Robotics",
    "exchange": "NASDAQ",
    "sector": "Technology",
    "industry": "Industrial Automation",
    "price": 733.8,
    "change": -16.52,
    "changePercent": -2.2,
    "previousClose": 750.32,
    "open": 750.03,
    "dayHigh": 751.29,
    "dayLow": 731.5,
    "volume": 3471317,
    "avgVolume": 2962633,
    "marketCap": 982258754565,
    "peRatio": 60.35,
    "eps": 12.16,
    "dividendYield": null,
    "week52High": 963.99,
    "week52Low": 583.89,
    "afterHoursPrice": 731,
    "afterHoursChangePercent": -0.38,
    "updatedAt": "2026-11-12T21:00:00.000Z"
  },
  "meta": {
    "provider": "demo",
    "generatedAt": "2026-11-12T21:00:04.512Z",
    "disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice."
  }
}

ローソク足を取得

GET/api/candles/{symbol}

OHLCVのローソク足を古い順に返します。1Dレンジは30-minute間隔を使用し、それ以外のレンジは日足を使用します。存在しないレンジは400 bad_requestを返します。

パラメータ

パラメータ場所型必須説明
symbolpathstring必須銘柄または指数のsymbol。例えば NWRB。大文字と小文字は区別されません。
rangequerystring任意1D, 5D, 1M, 6M, 1Y, 5Y のいずれか。デフォルトは1M。

リクエスト

curl -s "http://localhost:3000/api/candles/NWRB?range=1M"

レスポンス例

200application/json

{
  "data": [
    {
      "time": "2026-11-11",
      "open": 757.4,
      "high": 761.18,
      "low": 743.92,
      "close": 750.32,
      "volume": 3531710
    },
    {
      "time": "2026-11-12",
      "open": 750.03,
      "high": 751.29,
      "low": 731.5,
      "close": 733.8,
      "volume": 3471317
    }
  ],
  "meta": {
    "provider": "demo",
    "generatedAt": "2026-11-12T21:00:04.512Z",
    "disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
    "symbol": "NWRB",
    "range": "1M"
  }
}

サンプルは2本のローソク足に短縮しています。1Mは22本を返します。

銘柄をスクリーニング

GET/api/screener

スクリーナーページと同じパラメータで銘柄を絞り込み、並べ替え、ページ分割します。結果はrowsとともにtotal、page、pageSizeを含みます。解析できない値は無視されます。

パラメータ

パラメータ場所型必須説明
sectorquerystring任意正確なセクター名: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate。
minMarketCap, maxMarketCapquerynumber任意USD建ての時価総額の範囲。
minPrice, maxPricequerynumber任意USD建ての価格の範囲。
minChangePercent, maxChangePercentquerynumber任意パーセントポイント単位の日次変動の範囲: -3は-3%を意味します。
minVolumequerynumber任意1日あたりの最小出来高(株数)。
profitableOnlyquerystring任意1に設定すると、EPSが0より大きい銘柄だけを残します。
sortquerystring任意並べ替えフィールド: marketCap(デフォルト)、price、changePercent、volume、symbol。
orderquerystring任意並べ替え順: desc(デフォルト)またはasc。
pagequerynumber任意ページ番号。1から始まります。
pageSizequerynumber任意1ページあたりの行数: デフォルトは20、最大100。

リクエスト

curl -s "http://localhost:3000/api/screener?profitableOnly=1&pageSize=5"

レスポンス例

200application/json

{
  "data": {
    "rows": [
      {
        "symbol": "NWRB",
        "name": "Northwind Robotics",
        "exchange": "NASDAQ",
        "sector": "Technology",
        "industry": "Industrial Automation",
        "price": 733.8,
        "change": -16.52,
        "changePercent": -2.2,
        "previousClose": 750.32,
        "open": 750.03,
        "dayHigh": 751.29,
        "dayLow": 731.5,
        "volume": 3471317,
        "avgVolume": 2962633,
        "marketCap": 982258754565,
        "peRatio": 60.35,
        "eps": 12.16,
        "dividendYield": null,
        "week52High": 963.99,
        "week52Low": 583.89,
        "afterHoursPrice": 731,
        "afterHoursChangePercent": -0.38,
        "updatedAt": "2026-11-12T21:00:00.000Z"
      }
    ],
    "total": 17,
    "page": 1,
    "pageSize": 5
  },
  "meta": {
    "provider": "demo",
    "generatedAt": "2026-11-12T21:00:04.512Z",
    "disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
    "total": 17,
    "page": 1,
    "pageSize": 5
  }
}

サンプルは1行に短縮しています。

認証

デモモードではキーは不要です。サーバーが API_KEY 環境変数を設定している場合、すべてのリクエストは X-API-Key ヘッダーで同じ値を送る必要があります。それ以外は 401 unauthorized を受け取ります。

curl -s "http://localhost:3000/api/quotes/NWRB" \
  -H "X-API-Key: your-key-here"
注意
キーはサーバー上でのみ読み取られます。このページの「リクエストを送信」ボタンはブラウザからキーなしでAPIを呼び出すため、キー認証が有効な間は401を返します。

エラーコード

失敗したリクエストは対応するHTTPステータスと1つのエラーオブジェクトを返します。分岐は code で行い、message は人向けに書かれており変更される可能性があります。

{
  "error": {
    "code": "not_found",
    "message": "A human-readable explanation."
  }
}
HTTPステータスコード発生する条件
400bad_requestパラメータ値が許可されていません。例えば存在しないローソク足レンジです。
401unauthorizedAPI_KEY が設定されており、リクエストに一致する X-API-Key ヘッダーがありません。
404not_foundそのsymbolはデータセットに存在しません。
405method_not_allowedAPIは読み取り専用です: /api/quotes はPOSTに対してこのコードを返します。
429rate_limited1つのIPアドレスから1つのエンドポイントへ 60 秒間に 60 リクエストを超えた場合。レスポンスにはRetry-Afterが秒単位で含まれます。

プロダクトで同じデータを見る

マーケット概要、クオートページ、スクリーナーは、これらのエンドポイントと同じプロバイダーを読み取ります。