Below is a table of result/error codes provided by the API methods when a customer application encounters an error or Whisperer API violation.
| APIResult | Description |
|---|---|
| OK | Success (no error) |
COULD_NOT_CONNECT | Connection failed, Server down or invalid host/port |
| TIMEOUT | Keepalive messages timed out connection probably stale |
| BUFFER_FULL | Incoming or outgoing buffers are full |
| COULD_NOT_OPEN | File could not be opened |
SOCKERR_DNS | Error resolving the remote address for connection |
| SOCKERR_CREATE | Error creating communication socket |
| SOCKERR_CONNECT | Error connecting to the remote port |
| SOCKERR_CLOSED | Connection closed unexpectedly |
| SOCKERR_READING | Error reading from the remote socket |
| SOCKERR_WRITING | Error writing to the remote socket |
| NOT_CONNECTED | The dispatcher is not connected |
| NOT_RUNNING | The dispatcher is not running |
| IS_CONNECTED | The client is already connected |
| IS_RUNNING | The dispatcher is already running; only one thread may dispatch on a client instance. |
| IS_STOPPING | The dispatcher is stopping; no more outgoing messages allowed |
| EXCEPTION_THROWN | An exception was raised within a handler function |
| PROTOCOL_ERROR | An error occurred while encoding/decoding the network protocol. |
| INCOMPATIBLE_PROTOCOL | The server protocol version is incompatible with the client's protocol version. |
| INVALID_USER | The supplied username is invalid |
| INVALID_PASSWORD | The supplied password is invalid for the given username. |
| USER_ALREADY_CONNECTED | The supplied username is already connected to the server via another client |
| COULD_NOT_LOGIN | Other error attempting to login |
| INVALID_FEED | The FeedID provided is invalid |
| INVALID_MARKET | The MarketID provided is invalid |
| INVALID_ORDERID | Unable to handle invalid/zero/ or negative price or amount |
| INVALID_BATCHID | The batch definition ID provided is invalid |
| INVALID_CLIENT_ORDERID | The client ID provided is invalid |
| INVALID_MARKETDATA_FEED | The Feed does not support Marketdata |
| INVALID_TRADING_FEED | The Feed does not support Trading |
| USER_LOCKED | The user is prohibited from logging in |
| SYSTEM_LOCKED | Server is locked, no users will be able to connect |
| ADMIN_HANDLER_FAULT | Admin users must use the API's admin handler, normal users must not |
| INVALID_PERAMETER | A parameter provided is invalid |
| NOT_IMPLEMENTED | The feature is not implemented |
| NOT_APPLICABLE | Null |
Overview
Content Tools