<aside> ℹ️

Authorization Tokens obtained from v1 Api by default have scope: all This means, if you are using v1 auth, you can ignore scope requirements, for now.

But, eventually v1 login endpoint would be removed in favor of OAuth2.0 system.

</aside>

<aside> ⚠️

Do not mix v1 socket status management with v2 socket status management. You must be sure that the user is only using one backend at a time.

</aside>

General

Web socket server address: wss://warframe.market/socket-v2

Version

Documentation describes: v0.5.0

Protocol

Our sockets are using wfm sub-protocol, do not forget to set it while establishing your connection, otherwise your connection would be dropped. Example

socket = new WebSocket('wss://warframe.market/socket-v2', 'wfm');

We are passing JSON-encoded messages.

Message Structure

{
	route: "string"
	payload: any,
	id: "string",
	refId: "id"
}

Where:

• route – Indicates which part of the application should handle this message. The application should implement a routing system that maps the route value to the appropriate handler.
• payload – Arbitrary data. This can be a JSON object, string, byte array, or anything else, depending on the expectations of the target handler. You can think of it as a “sub-message” or a route-specific request.
• id – A unique identifier for this message (either incoming or outgoing).
• refId – A reference to the id of another message. This field is used when sending a response to a previous message. It acts as a correlation ID.

Messages