Class QuoteContext

Set quote callback, after receiving the quote data push, it will call back to this function.

Set depth callback, after receiving the depth data push, it will call back to this function.

Set brokers callback, after receiving the brokers data push, it will call back to this function.

Set trades callback, after receiving the trades data push, it will call back to this function.

Set candlestick callback, after receiving the trades data push, it will call back to this function.

Subscribe

Example

const { Config, QuoteContext, SubType } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => {
    ctx.setOnQuote((_, event) => console.log(event.toString()));
    ctx.subscribe(["700.HK", "AAPL.US"], [SubType.Quote], true);
  });
Copy

Unsubscribe

Example

const { Config, QuoteContext, SubType } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => {
    ctx.subscribe(["700.HK", "AAPL.US"], [SubType.Quote], true)
      .then(() => ctx.unsubscribe(["AAPL.US"], [SubType.Quote], true)))
  })
Copy

Subscribe security candlesticks

Unsubscribe security candlesticks

Get subscription information

Example

const { Config, QuoteContext, SubType } = require("longport")

let config = Config.fromEnv();
QuoteContext.new(config)
  .then((ctx) => {
    return ctx
      .subscribe(["700.HK", "AAPL.US"], [SubType.Quote], true)
      .then(() => ctx.subscriptions());
  })
  .then((resp) => console.log(resp.toString()));
Copy

Get basic information of securities

Example

const { Config, QuoteContext } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.staticInfo(["700.HK", "AAPL.US", "TSLA.US", "NFLX.US"]))
  .then((resp) => {
    for (let obj of resp) {
      console.log(obj.toString())
    }
  })
Copy

Get quote of securities

Example

const { Config, QuoteContext } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.quote(["700.HK", "AAPL.US", "TSLA.US", "NFLX.US"]))
  .then((resp) => {
    for (let obj of resp) {
      console.log(obj.toString())
    }
  })
Copy

Get quote of option securities

Example

import { Config, QuoteContext } from 'longport'

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.optionQuote(["AAPL230317P160000.US"]))
  .then((resp) => {
    for (let obj of resp) {
      console.log(obj.toString())
    }
  })
Copy

Get quote of warrant securities

Example

const { Config, QuoteContext } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.warrantQuote(["21125.HK"]))
  .then((resp) => {
    for (let obj of resp) {
      console.log(obj.toString())
    }
  })
Copy

Get security depth

Example

const { Config, QuoteContext } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.depth("700.HK"))
  .then((resp) => console.log(resp.toString()))
Copy

Get security brokers

Example

const { Config, QuoteContext } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.brokers("700.HK"))
  .then((resp) => console.log(resp.toString()))
Copy

Get participants

Example

const { Config, QuoteContext } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.participants())
  .then((resp) => {
    for (let obj of resp) {
      console.log(obj.toString());
    }
  })
Copy

Get security trades

Example

const { Config, QuoteContext } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.trades("700.HK", 10))
  .then((resp) => {
    for (let obj of resp) {
      console.log(obj.toString());
    }
  })
Copy

Get security intraday

Example

const { Config, QuoteContext } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.intraday("700.HK"))
  .then((resp) => {
    for (let obj of resp) {
      console.log(obj.toString());
    }
  })
Copy

Get security candlesticks

Example

const { Config, QuoteContext, Period, AdjustType } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.candlesticks("700.HK", Period.Day, 10, AdjustType.NoAdjust))
  .then((resp) => {
    for (let obj of resp) {
      console.log(obj.toString());
    }
  })
Copy

Get security history candlesticks by offset

Get security history candlesticks by date

Get option chain expiry date list

Example

const { Config, QuoteContext } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.optionChainExpiryDateList("AAPL.US"))
  .then((resp) => {
    for (let obj of resp) {
      console.log(obj.toString())
    }
  })
Copy

Get option chain info by date

Example

const { Config, QuoteContext, NaiveDate } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.optionChainInfoByDate("AAPL.US", new NaiveDate(2023, 1, 20)))
  .then((resp) => {
    for (let obj of resp) {
      console.log(obj.toString())
    }
  })
Copy

Get warrant issuers

Example

const { Config, QuoteContext, NaiveDate } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.warrantIssuers())
  .then((resp) => {
    for (let obj of resp) {
      console.log(obj.toString())
    }
  })
Copy

Query warrant list

Example

const { Config, QuoteContext, WarrantSortBy, SortOrderType } = require("longport")
let config = Config.fromEnv()
QuoteContext.new(config)
 .then((ctx) => ctx.warrantList("700.HK", WarrantSortBy.LastDone, SortOrderType.Asc))
.then((resp) => {
 for (let obj of resp) {
  console.log(obj.toString())
}
})
Copy

Get trading session of the day

Example

const { Config, QuoteContext, NaiveDate } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.tradingSession())
  .then((resp) => {
    for (let obj of resp) {
      console.log(obj.toString())
    }
  })
Copy

Get trading session of the day

Example

const { Config, QuoteContext, Market, NaiveDate } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.tradingDays(Market.HK, new NaiveDate(2022, 1, 20), new NaiveDate(2022, 2, 20)))
  .then((resp) => console.log(resp.toString()))
Copy

Get capital flow intraday

Example

const { Config, QuoteContext } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.capitalFlow("700.HK"))
  .then((resp) => {
    for (let obj of resp) {
      console.log(obj.toString())
    }
  })
Copy

Get capital distribution

Example

const { Config, QuoteContext } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.capitalDistribution("700.HK"))
  .then((resp) => console.log(resp.toString()))
Copy

Get calc indexes

Get watchlist

Example

const { Config, QuoteContext } = require("longport")

let config = Config.fromEnv()
QuoteContext.new(config)
  .then((ctx) => ctx.watchList())
  .then((resp) => console.log(resp.toString()))
Copy

Create watchlist group

Example

const { Config, QuoteContext } = require("longport")

let config = Config.fromEnv();
QuoteContext.new(config)
  .then((ctx) => {
    ctx.createWatchlistGroup({
      name: "Watchlist1",
      securities: ["700.HK", "BABA.US"],
    })
  .then((group_id) => console.log(group_id));
});
Copy

Delete watchlist group

Example

const { Config, QuoteContext } = require("longport")
let config = Config.fromEnv();
QuoteContext.new(config)
  .then(ctx => ctx.deleteWatchlistGroup({ id: 10086 });
Copy

Update watchlist group

Example

const { Config, QuoteContext } = require("longport")
let config = Config.fromEnv();
QuoteContext.new(config)
  .then(ctx => ctx.updateWatchlistGroup({
    id: 10086,
    name: "Watchlist2",
    securities: ["700.HK", "BABA.US"],
  });
Copy

Get security list

Example

const { Config, QuoteContext, Market, SecurityListCategory } = require("longport")

let config = Config.fromEnv();
QuoteContext.new(config)
  .then((ctx) => ctx.securityList(Market.US, SecurityListCategory.Overnight))
  .then((resp) => console.log(resp.toString()));
Copy

Get real-time quote

Example

const { Config, QuoteContext, SubType } = require("longport")

let config = Config.fromEnv();
QuoteContext.new(config).then((ctx) => {
  ctx.subscribe(["700.HK", "AAPL.US"], [SubType.Quote], true).then(() => {
    setTimeout(() => {
      ctx.realtimeQuote(["700.HK", "AAPL.US"]).then((resp) => {
        for (let obj of resp) {
          console.log(obj.toString());
        }
      });
    }, 5000);
  });
});
Copy

Get real-time depth

Example

const { Config, QuoteContext, SubType } = require("longport")

let config = Config.fromEnv();
QuoteContext.new(config).then((ctx) => {
  ctx.subscribe(["700.HK", "AAPL.US"], [SubType.Depth], true);
  setTimeout(
    () =>
      ctx.realtimeDepth("700.HK").then((resp) => console.log(resp.toString())),
    5000
  );
});
Copy

Get real-time brokers

Example

const { Config, QuoteContext, NaiveDate, SubType } = require("longport")

let config = Config.fromEnv();
QuoteContext.new(config).then((ctx) => {
  ctx.subscribe(["700.HK", "AAPL.US"], [SubType.Brokers], true).then(() => {
    setTimeout(
      () =>
        ctx
          .realtimeBrokers("700.HK")
          .then((resp) => console.log(resp.toString())),
      5000
    );
  });
});
Copy

Get real-time trades

Example

const { Config, QuoteContext, SubType } = require("longport")

let config = Config.fromEnv();
QuoteContext.new(config).then((ctx) => {
  ctx.subscribe(["700.HK", "AAPL.US"], [SubType.Trade], false).then(() => {
    setTimeout(() => {
      ctx.realtimeTrades("700.HK", 10).then((resp) => {
        for (let obj of resp) {
          console.log(obj.toString());
        }
      });
    }, 5000);
  });
});
Copy

Get real-time candlesticks

Example

const { Config, QuoteContext, Period } = require("longport")

let config = Config.fromEnv();
QuoteContext.new(config).then((ctx) => {
  ctx.subscribeCandlesticks("700.HK", Period.Min_1).then(() => {
    setTimeout(() => {
      ctx.realtimeCandlesticks("700.HK", Period.Min_1, 10).then((resp) => {
        for (let obj of resp) {
          console.log(obj.toString());
        }
      });
    }, 5000);
  });
});
Copy