> ## Documentation Index > Fetch the complete documentation index at: https://api.alphainsider.com/llms.txt > Use this file to discover all available pages before exploring further. # Subscribe > Subscribe to real-time updates from AlphaInsider. ## AsyncAPI ````yaml asyncapi.yaml subscribe id: subscribe title: Subscribe description: '' servers: - id: production protocol: wss host: alphainsider.com bindings: [] variables: [] address: /ws parameters: [] bindings: [] operations: - &ref_11 id: subscribeSend title: Subscribe send description: Subscribe to websocket channels. type: receive messages: - &ref_13 id: ping payload: - type: string const: ping x-parser-schema-id: name: Ping description: >- Client heartbeat message to keep the connection alive.
We recommend sending a ping every 30 seconds. headers: [] jsonPayloadSchema: type: string const: ping x-parser-schema-id: title: Ping description: >- Client heartbeat message to keep the connection alive.
We recommend sending a ping every 30 seconds. example: '"ping"' bindings: [] extensions: - id: x-parser-unique-object-id value: ping - id: x-parser-message-name value: ping - &ref_14 id: subscribe payload: - name: Subscribe description: >- Client request to subscribe to one or more channels.
A new subscribe request overwrites all previous subscriptions. type: object properties: - name: event type: string description: subscribe required: true - name: payload type: object required: true properties: - name: channels type: array required: true properties: - name: item type: string required: false - name: token type: string required: true headers: [] jsonPayloadSchema: type: object required: - event - payload properties: event: type: string const: subscribe x-parser-schema-id: payload: type: object required: - channels - token properties: channels: type: array items: type: string x-parser-schema-id: x-parser-schema-id: token: type: string x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: title: Subscribe description: >- Client request to subscribe to one or more channels.
A new subscribe request overwrites all previous subscriptions. example: |- { "event": "subscribe", "payload": { "channels": [ "wsStockPrice:", "wsStrategyValue:", "wsOrders:", "wsPositions:", "wsTimelines:", "wsBotStatus:", "wsBotAllocations:", "wsBotActivities:" ], "token": "" } } bindings: [] extensions: - id: x-parser-unique-object-id value: subscribe - id: x-parser-message-name value: subscribe bindings: [] extensions: &ref_10 - id: x-parser-unique-object-id value: subscribe - &ref_12 id: subscribeReceive title: Subscribe receive description: Receive messages from websocket channels. type: send messages: - &ref_15 id: pingResponse payload: - type: string const: pong x-parser-schema-id: name: Ping Response description: Server heartbeat response to a client ping. headers: [] jsonPayloadSchema: type: string const: pong x-parser-schema-id: title: Ping Response description: Server heartbeat response to a client ping. example: '"pong"' bindings: [] extensions: - id: x-parser-unique-object-id value: pingResponse - id: x-parser-message-name value: pingResponse - &ref_16 id: subscribeResponse payload: - type: array items: &ref_0 type: object x-parser-schema-id: x-parser-schema-id: name: Subscribe Response description: Server confirmation of successful subscription. headers: [] jsonPayloadSchema: type: array items: *ref_0 x-parser-schema-id: title: Subscribe Response description: Server confirmation of successful subscription. example: |- [ { "event": "subscribe", "channel": "wsStockPrice:64diisPJwIqt99jyjoIGT", "response": "Subscribed to channel." } ] bindings: [] extensions: - id: x-parser-unique-object-id value: subscribeResponse - id: x-parser-message-name value: subscribeResponse - &ref_17 id: error payload: - type: array items: &ref_1 type: object x-parser-schema-id: x-parser-schema-id: name: Error Response description: >- Server error response, which may include a specific channel.
We recommend reconnecting if an error occurs. headers: [] jsonPayloadSchema: type: array items: *ref_1 x-parser-schema-id: title: Error Response description: >- Server error response, which may include a specific channel.
We recommend reconnecting if an error occurs. example: |- [ { "event": "error", "response": "Request failed." }, { "event": "error", "response": "Authentication failed." }, { "event": "error", "channel": "wsStockPrice:64diisPJwIqt99jyjoIGT", "response": "Failed to subscribe to channel." }, { "event": "error", "channel": "wsStockPrice:64diisPJwIqt99jyjoIGT", "response": "Channel closed." } ] bindings: [] extensions: - id: x-parser-unique-object-id value: error - id: x-parser-message-name value: error - &ref_18 id: wsStockPrice payload: - type: array items: &ref_2 type: object x-parser-schema-id: x-parser-schema-id: name: Stock Price description: >- Real-time stock price update (every 1 second).
You can use either the internal stock ID or `"stock:exchange"` format (e.g. `"AAPL:XNAS"`). To lookup available stock_ids use the [/searchstocks](https://api.alphainsider.com/resources/stocks/searchstocks) or [/getallstocks](https://api.alphainsider.com/resources/stocks/getallstocks) endpoints. headers: [] jsonPayloadSchema: type: array items: *ref_2 x-parser-schema-id: title: Stock Price description: >- Real-time stock price update (every 1 second).
You can use either the internal stock ID or `"stock:exchange"` format (e.g. `"AAPL:XNAS"`). To lookup available stock_ids use the [/searchstocks](https://api.alphainsider.com/resources/stocks/searchstocks) or [/getallstocks](https://api.alphainsider.com/resources/stocks/getallstocks) endpoints. example: |- [ { "event": "wsStockPrice", "channel": "wsStockPrice:yv4fbstPFFxgngHWPwnNq", "response": { "stock_id": "yv4fbstPFFxgngHWPwnNq", "bid": "675.59", "ask": "675.59", "last": "675.18" } } ] bindings: [] extensions: - id: x-parser-unique-object-id value: wsStockPrice - id: x-parser-message-name value: wsStockPrice - &ref_19 id: wsStrategyValue payload: - type: array items: &ref_3 type: object x-parser-schema-id: x-parser-schema-id: name: Strategy Value description: Real-time strategy value update (every 5 seconds). headers: [] jsonPayloadSchema: type: array items: *ref_3 x-parser-schema-id: title: Strategy Value description: Real-time strategy value update (every 5 seconds). example: |- [ { "event": "wsStrategyValue", "channel": "wsStrategyValue:IMgszSAVzapxSQCbYZC--", "response": { "strategy_id": "IMgszSAVzapxSQCbYZC--", "strategy_value": "0.99998930000000000" } } ] bindings: [] extensions: - id: x-parser-unique-object-id value: wsStrategyValue - id: x-parser-message-name value: wsStrategyValue - &ref_20 id: wsOrders payload: - type: array items: &ref_4 type: object properties: event: type: string x-parser-schema-id: channel: type: string x-parser-schema-id: response: type: array items: type: object properties: type: type: string enum: - market - limit - stop_market - stop_limit - oco - liquidate x-parser-schema-id: action: type: string enum: - buy - sell x-parser-schema-id: security: type: string enum: - cryptocurrency - stock x-parser-schema-id: provider: type: string enum: - coinbase - binance - massive - alphainsider x-parser-schema-id: stock_status: type: string enum: - active - deleted x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: Orders description: Updates for open orders (instant). headers: [] jsonPayloadSchema: type: array items: *ref_4 x-parser-schema-id: title: Orders description: Updates for open orders (instant). example: |- [ { "event": "wsOrders", "channel": "wsOrders:IMgszSAVzapxSQCbYZC--", "response": [ { "order_id": "i9wtRL8_CsiT9krl1Zp_e", "strategy_id": "IMgszSAVzapxSQCbYZC--", "type": "market", "action": "buy", "stop_price": null, "price": null, "amount": "0.000010000000000", "total": null, "created_at": "2026-04-08T13:46:23.606Z", "stock_id": "yv4fbstPFFxgngHWPwnNq", "figi_composite": "BBG000BDTBL9", "symbol": "SPY", "name": "State Street SPDR S&P 500 ETF Trust", "sector": "Exchange Traded Fund", "security": "stock", "exchange": "ARCX", "stock": "SPY", "peg": "USD", "provider": "polygon", "slippage": "0.000000000000000", "fee": "0.000000000000000", "links": {}, "stock_status": "active", "bid": "675.53", "ask": "675.53", "last": "675.18", "order_dependencies": [] } ] } ] bindings: [] extensions: - id: x-parser-unique-object-id value: wsOrders - id: x-parser-message-name value: wsOrders - &ref_21 id: wsPositions payload: - type: array items: &ref_5 type: object properties: event: type: string x-parser-schema-id: channel: type: string x-parser-schema-id: response: type: array items: type: object properties: type: type: string enum: - asset - liability x-parser-schema-id: security: type: string enum: - cryptocurrency - stock x-parser-schema-id: provider: type: string enum: - coinbase - binance - massive - alphainsider x-parser-schema-id: stock_status: type: string enum: - active - deleted x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: Positions description: Updates for strategy positions (instant). headers: [] jsonPayloadSchema: type: array items: *ref_5 x-parser-schema-id: title: Positions description: Updates for strategy positions (instant). example: |- [ { "event": "wsPositions", "channel": "wsPositions:IMgszSAVzapxSQCbYZC--", "response": [ { "position_id": "biwu829fLOSI2enaRVuIx", "strategy_id": "IMgszSAVzapxSQCbYZC--", "type": "asset", "price": "1.000000000000000", "amount": "0.993242800000000", "total": "0.993242800000000", "updated_at": "2026-04-08T13:46:24.908Z", "created_at": "2026-04-08T13:46:24.908Z", "stock_id": "ubfhvYUsgvMIuJPwr76My", "figi_composite": null, "symbol": "USD", "name": "US Dollar", "sector": "Unallocated", "security": "", "exchange": "ALPHAINSIDER", "stock": "USD", "peg": "USD", "provider": "alphainsider", "slippage": "0.000000000000000", "fee": "0.000000000000000", "links": {}, "stock_status": "active", "bid": "1.00", "ask": "1.00", "last": "1.00" }, { "position_id": "mfx507iaGBpuNkgYi_Oob", "strategy_id": "IMgszSAVzapxSQCbYZC--", "type": "asset", "price": "675.720000000000000", "amount": "0.000010000000000", "total": "0.006757200000000", "updated_at": "2026-04-08T13:46:24.908Z", "created_at": "2026-04-08T13:46:24.908Z", "stock_id": "yv4fbstPFFxgngHWPwnNq", "figi_composite": "BBG000BDTBL9", "symbol": "SPY", "name": "State Street SPDR S&P 500 ETF Trust", "sector": "Exchange Traded Fund", "security": "stock", "exchange": "ARCX", "stock": "SPY", "peg": "USD", "provider": "polygon", "slippage": "0.000000000000000", "fee": "0.000000000000000", "links": {}, "stock_status": "active", "bid": "675.73", "ask": "675.73", "last": "675.19" } ] } ] bindings: [] extensions: - id: x-parser-unique-object-id value: wsPositions - id: x-parser-message-name value: wsPositions - &ref_22 id: wsTimelines payload: - type: array items: &ref_6 type: object properties: event: type: string x-parser-schema-id: channel: type: string x-parser-schema-id: response: type: object properties: data: type: object properties: security: type: string enum: - cryptocurrency - stock x-parser-schema-id: provider: type: string enum: - coinbase - binance - massive - alphainsider x-parser-schema-id: stock_status: type: string enum: - active - deleted x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: Timelines description: New strategy timeline events (instant). headers: [] jsonPayloadSchema: type: array items: *ref_6 x-parser-schema-id: title: Timelines description: New strategy timeline events (instant). example: |- [ { "event": "wsTimelines", "channel": "wsTimelines:IMgszSAVzapxSQCbYZC--", "response": { "timeline_id": "1", "created_at": "2026-04-08T13:46:24.908Z", "strategy_id": "IMgszSAVzapxSQCbYZC--", "name": "test stocks", "user_id": "user_1", "likes": "0", "liked": false, "type": "trade", "data": { "history_id": "hdyS4tHfSXV3fOVaDNRPV", "action": "buy", "price": "675.720000000000000", "amount": "0.000010000000000", "fee_total": "0.000000000000000", "total": "0.006757200000000", "new_holdings": "0.000010000000000", "strategy_value": "1.000000000000000", "stock_id": "yv4fbstPFFxgngHWPwnNq", "figi_composite": "BBG000BDTBL9", "symbol": "SPY", "name": "State Street SPDR S&P 500 ETF Trust", "sector": "Exchange Traded Fund", "security": "stock", "exchange": "ARCX", "stock": "SPY", "peg": "USD", "provider": "polygon", "slippage": "0.000000000000000", "fee": "0.000000000000000", "links": {}, "stock_status": "active" } } } ] bindings: [] extensions: - id: x-parser-unique-object-id value: wsTimelines - id: x-parser-message-name value: wsTimelines - &ref_23 id: wsBotStatus payload: - type: array items: &ref_7 type: object properties: event: type: string x-parser-schema-id: channel: type: string x-parser-schema-id: response: type: object properties: status: type: string enum: - 'on' - scheduled_rebalance - rebalancing - scheduled_close - closing - stopping - 'off' x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: Bot Status description: Bot status changes (instant). headers: [] jsonPayloadSchema: type: array items: *ref_7 x-parser-schema-id: title: Bot Status description: Bot status changes (instant). example: |- [ { "event": "wsBotStatus", "channel": "wsBotStatus:FSGV8HoplnWqotw5upiyV", "response": { "bot_id": "FSGV8HoplnWqotw5upiyV", "status": "on" } } ] bindings: [] extensions: - id: x-parser-unique-object-id value: wsBotStatus - id: x-parser-message-name value: wsBotStatus - &ref_24 id: wsBotAllocations payload: - type: array items: &ref_8 type: object properties: event: type: string x-parser-schema-id: channel: type: string x-parser-schema-id: response: type: array items: type: object properties: positions: type: array items: type: object properties: type: type: string enum: - asset - liability x-parser-schema-id: security: type: string enum: - cryptocurrency - stock x-parser-schema-id: provider: type: string enum: - coinbase - binance - massive - alphainsider x-parser-schema-id: stock_status: type: string enum: - active - deleted x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: Bot Allocations description: Bot allocation changes (instant). headers: [] jsonPayloadSchema: type: array items: *ref_8 x-parser-schema-id: title: Bot Allocations description: Bot allocation changes (instant). example: |- [ { "event": "wsBotAllocations", "channel": "wsBotAllocations:FSGV8HoplnWqotw5upiyV", "response": [ { "bot_allocation_id": "FLyLk7XLHW31SXZSMq1uS", "bot_id": "FSGV8HoplnWqotw5upiyV", "strategy_id": "IMgszSAVzapxSQCbYZC--", "percent": "0.8000000480005932873330314362685522793061722242886922082356937931", "strategy_value": "0.9999877", "positions": [ { "position_id": "biwu829fLOSI2enaRVuIx", "strategy_id": "IMgszSAVzapxSQCbYZC--", "type": "asset", "price": "1.000000000000000", "amount": "0.993242800000000", "total": "0.993242800000000", "updated_at": "2026-04-08T13:46:24.908Z", "created_at": "2026-04-08T13:46:24.908Z", "stock_id": "ubfhvYUsgvMIuJPwr76My", "figi_composite": null, "symbol": "USD", "name": "US Dollar", "sector": "Unallocated", "security": "", "exchange": "ALPHAINSIDER", "stock": "USD", "peg": "USD", "provider": "alphainsider", "slippage": "0.000000000000000", "fee": "0.000000000000000", "links": {}, "stock_status": "active", "bid": "1.00", "ask": "1.00", "last": "1.00" }, { "position_id": "mfx507iaGBpuNkgYi_Oob", "strategy_id": "IMgszSAVzapxSQCbYZC--", "type": "asset", "price": "675.720000000000000", "amount": "0.000010000000000", "total": "0.006757200000000", "updated_at": "2026-04-08T13:46:24.908Z", "created_at": "2026-04-08T13:46:24.908Z", "stock_id": "yv4fbstPFFxgngHWPwnNq", "figi_composite": "BBG000BDTBL9", "symbol": "SPY", "name": "State Street SPDR S&P 500 ETF Trust", "sector": "Exchange Traded Fund", "security": "stock", "exchange": "ARCX", "stock": "SPY", "peg": "USD", "provider": "polygon", "slippage": "0.000000000000000", "fee": "0.000000000000000", "links": {}, "stock_status": "active", "bid": "674.49", "ask": "674.53", "last": "674.2" } ], "updated_at": "2026-04-08T13:57:12.784Z", "created_at": "2026-04-08T13:57:12.784Z" } ] } ] bindings: [] extensions: - id: x-parser-unique-object-id value: wsBotAllocations - id: x-parser-message-name value: wsBotAllocations - &ref_25 id: wsBotActivities payload: - type: array items: &ref_9 type: object properties: event: type: string x-parser-schema-id: channel: type: string x-parser-schema-id: response: type: object properties: type: type: string enum: - start - stop - info - warning - error x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: x-parser-schema-id: name: Bot Activities description: New bot activities (instant). headers: [] jsonPayloadSchema: type: array items: *ref_9 x-parser-schema-id: title: Bot Activities description: New bot activities (instant). example: |- [ { "event": "wsBotActivities", "channel": "wsBotActivities:FSGV8HoplnWqotw5upiyV", "response": { "bot_activity_id": "2h0-0OBMXOcl5wjkoGjKf", "bot_id": "FSGV8HoplnWqotw5upiyV", "type": "start", "message": "Bot started.", "created_at": "2026-04-08T13:51:31.553Z" } } ] bindings: [] extensions: - id: x-parser-unique-object-id value: wsBotActivities - id: x-parser-message-name value: wsBotActivities bindings: [] extensions: *ref_10 sendOperations: - *ref_11 receiveOperations: - *ref_12 sendMessages: - *ref_13 - *ref_14 receiveMessages: - *ref_15 - *ref_16 - *ref_17 - *ref_18 - *ref_19 - *ref_20 - *ref_21 - *ref_22 - *ref_23 - *ref_24 - *ref_25 extensions: - id: x-parser-unique-object-id value: subscribe securitySchemes: [] ````