API Reference

Login

Rate Limit: 1 requests per 1 seconds per apiKey

Login

URL

  • WebSocket private subscription channels: wss://wss.liquiditytech.com/v1/private

Tip:
Login requires sign, Please refer to
https://apidocliquidity.readme.io/reference/get-started-with-ltp-api-v2

If you do not subscribe or the server does not push data to the user within 30 seconds after the subscription, the system automatically disconnects the user

To keep the connection valid and stable, it is recommended that you do the following:

  1. After receiving a message, the user sets a timer for N seconds. The timer value is less than 30.
  2. If the timer is triggered (no new message is received within N seconds), send the string 'ping'.
  3. Expect a literal string 'pong' in response. If you do not receive it within N seconds, issue an error or reconnect.

Request

{  
 "action": "login",  
 "args":  
  {  
       "apiKey": "XXXX",  
       "timestamp": "1538054050",  
       "sign": "XXXX"  
   }  
}
Field nameTypeNecessaryRemarks
actionStringYAction
argsObjectYData
>apiKeyStringYApiKey
>timestampStringYTimestamp ,unit(Second)
>signStringYSign ,please refer to https://apidocliquidity.readme.io/reference/get-started-with-ltp-api-v2 java-websocket or python-websocket part

Response

Success example:

{  
  "event": "login",  
  "code": "0",  
  "msg": ""  
}

Fail example:

{  
  "event": "error",  
  "code": "60009",  
  "msg": "Login failed."  
}
Field nameTypeRemarks
eventStringEvent
codeStringCode
msgStringMsg