使用PHP对接美股股票市场API 实时数据、IPO和K线(Kline)的PHP对接方案

0 阅读3分钟

本文档面向开发者,详细介绍如何通过 StockTV API 获取美国股票市场的实时行情、历史 K 线、IPO 新股日历等数据。所有接口均返回标准 JSON 格式,支持 HTTP 和 WebSocket 两种接入方式。


1. 快速接入

  • Base URL: https://api.stocktv.top
  • 认证方式: 所有请求均需在 URL 参数中携带您的唯一 key
    • 示例: ?key=您的API_KEY
  • 数据格式: JSON
  • 美国市场标识:
    • 纽交所 (NYSE): exchangeId=1
    • 纳斯达克 (NASDAQ): exchangeId=2

2. 核心功能

2.1 实时行情

获取美国股票的实时报价、涨跌幅、成交量等关键数据,支持 HTTP 轮询和 WebSocket 推送。

接口示例 – 获取美股列表 (分页)

  • 端点: /stock/stocks

  • 方法: GET

  • 请求参数:

    • exchangeId: 1 (纽交所) 或 2 (纳斯达克)
    • pageSize: 10 (每页数量,默认 10)
    • page: 1 (页码,默认 1)
    • key: 您的 API Key
  • 响应示例:

    {
      "code": 200,
      "message": "操作成功",
      "data": {
        "records": [
          {
            "id": 7310,
            "name": "Apple Inc.",
            "symbol": "AAPL",
            "last": 175.32,
            "chg": 1.45,
            "chgPct": 0.83,
            "high": 176.20,
            "low": 174.80,
            "volume": 52340000,
            "time": 1716448222,
            "open": true,
            "exchangeId": 2
          }
        ],
        "total": 8000,
        "pages": 800
      }
    }
    

实时推送 (WebSocket)
通过 WebSocket 订阅,可获取毫秒级实时 Tick 数据,适合行情大屏、高频交易等场景。

  • 连接地址: wss://ws-api.stocktv.top/connect?key=您的API_KEY
  • 连接成功后需发送心跳保持连接
  • 推送数据示例:
    {
      "pid": "7310",
      "last_numeric": "175.32",
      "pc": "1.45",
      "pcp": "0.83",
      "high": "176.20",
      "low": "174.80",
      "turnover_numeric": "52340000",
      "time": "15:30:02",
      "timestamp": "1716448222",
      "type": 1
    }
    
2.2 IPO 新股日历

实时获取美国市场即将上市和已上市的新股信息,包括发行价、发行市值、上市日期等。

  • 端点: /stock/getIpo

  • 方法: GET

  • 请求参数:

    • key: 您的 API Key
    • countryId: 美国对应的国家 ID(请联系技术支持获取准确 ID
    • type: 1 (未上市) 或 2 (已上市),非必填
  • 响应示例:

    {
      "code": 200,
      "message": "操作成功",
      "data": [
        {
          "id": 101,
          "company": "Arm Holdings plc",
          "symbol": "ARM",
          "ipoPrice": "51.00",
          "ipoValue": "5.2B",
          "ipoListing": 1694476800,
          "date": "2023-09-14",
          "exchange": "NASDAQ",
          "pid": 1234567
        }
      ]
    }
    
2.3 K线数据

获取指定股票的历史 K 线数据,支持多种时间周期,用于技术分析和图表绘制。

  • 端点: /stock/kline

  • 方法: GET

  • 请求参数:

    • pid: 股票产品 ID (从上一步接口返回的 id 字段获取)
    • interval: K 线周期,可选值:
      • PT5M – 5分钟
      • PT15M – 15分钟
      • PT1H – 1小时
      • PT5H – 5小时
      • P1D – 1天
      • P1W – 1周
      • P1M – 1月
    • key: 您的 API Key
  • 响应示例:

    {
      "code": 200,
      "message": "操作成功",
      "data": [
        {
          "time": 1719818400000,
          "open": 174.80,
          "high": 176.20,
          "low": 174.50,
          "close": 175.32,
          "volume": 52340000,
          "vo": 0
        }
      ]
    }
    

3. 辅助功能

  • 指数行情: /stock/indices – 获取标普500、道琼斯、纳斯达克等美国主要指数实时数据。
  • 公司信息: /stock/companies – 查询公司简介、行业、员工数等基本面信息。
  • 涨跌排行榜: /stock/updownList – 获取美股涨幅榜、跌幅榜、涨停/跌停榜。
  • 国际新闻: /stock/news – 获取与美股市场相关的财经新闻。

4. 获取 API Key

请联系技术支持获取您的专属 API Key 及完整的国家/交易所 ID 列表。