Registry / communication / alphapoint-apex-api

alphapoint-apex-api

JSON →
library3.2.19jsnpmunverified

A JavaScript library for the Alphapoint API, providing RxJS observables for real-time events and RPC over WebSocket for get requests. Current stable version is 3.2.19. Release cadence is intermittent. Key differentiators: uses observables for streaming data, supports both Node.js and browser environments, and is designed specifically for the Alphapoint financial trading platform.

npm install alphapoint-apex-api
INSTALL
IMPORT
SIG · ALPHAPOINT-APEX-AP
A
alphapoint-apex-api
communicationjavascriptv3.2.19
Install
Import
Disk
Pass rate
0/ 6
Env Coverage0 / 6
glibc
1822
musl
1822
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
node 18226 runs
build_error
glibc
node 18226 runs
build_error
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

APEX
const { APEX } = require('alphapoint')
import { APEX } from 'alphapoint'
CommonJS require is the documented pattern; ES imports may not work directly depending on bundler.
APEX
import APEX from 'alphapoint'
Default ES import works in some setups; named import as documented may be preferred.
APEX
const APEX = require('alphapoint').APEX
const alphapoint = require('alphapoint'); const a = new alphapoint.APEX()
Destructuring is clearer.

Creates an APEX client, fetches L2 snapshot data using GetL2Snapshot method.

const { APEX } = require('alphapoint'); const apex = new APEX('wss://api_apexqa.alphapoint.com/WSGateway/'); async function main() { try { const l2 = await apex.GetL2Snapshot({OMSId: 1, InstrumentId: 2, Depth: 100}); console.log(l2); } catch (e) { console.error(e); } } main();
Debug
Known issues
gotchaWebSocket endpoint must be wss:// with correct host; otherwise connection fails silently.
fix
Ensure you use the correct wss:// URL provided by Alphapoint.
affects: >=1.0.0
gotchaAll methods return promises but some may reject with opaque errors on connection issues.
fix
Wrap calls in try/catch or use .catch() to handle promise rejections.
affects: >=1.0.0
Errors
Common errors & fixes
Cannot find module 'alphapoint'
Package not installed; requires .npmrc configuration to access private registry.
fix
Set up .npmrc with correct token and run 'npm install'.
TypeError: apex.GetL2Snapshot is not a function
Incorrect import or wrong version; ensure you have required { APEX } and instantiated correctly.
fix
Use: const { APEX } = require('alphapoint'); apex = new APEX(url);
Upgrade
Version history
3.2.19latest on npm
Audit
Dependencies
rxjsrequiredUsed for observable patterns for events
wsoptionalWebSocket implementation for Node.js
Agent activity
44 hits · last 30 days
node
38
Perplexity
1
OpenAI (training)
1
Resources
alphapoint-apex-api — npm install alphapoint-apex-api · libregistry