Forex

Forex rate data stream.

Connect

websocat

websocat wss://api.datamaxiplus.com/ws/v1/forex -H 'X-DTMX-APIKEY: $YOUR_API_KEY'

wscat

wscat -c wss://api.datamaxiplus.com/ws/v1/forex -H 'X-DTMX-APIKEY: $YOUR_API_KEY'

Subscribe

• method specifies the type of request.
• params list represents forex symbols (e.g. "USD-KRW") that user wants to subscribe. You can request the list of supported forex symbols with /api/v1/forex/symbols endpoint.
• id uniquely identifies the subscription request.

schema

{
  "method": "SUBSCRIBE",
  "params": [
    string
  ],
  "id": int32
}

example

{
  "method": "SUBSCRIBE",
  "params": [
    "USD-KRW"
  ],
  "id": 1
}

If the subscription was successful, the server responds with the message in the following format.

• result corresponds to a list of successfully subscribed symbols.
• id corresponds to the subscription request ID.

schema

{
  "result": [
    string
  ],
  "id": int32
}

example

{
  "result": [
    "USD-KRW"
  ],
  "id": 1
}

Response

Schema

Schema

sstring

Forex symbol.

dinteger

Date and time.

rnumber

Forex rate.

Example

{
  "s": "USD-KRW",
  "d": 1722913391794,
  "r": 1371.54
}