Websocket API

This document describes version 4 of the websocket API. Any earlier version is unsupported and may be withdrawn at any time.

Base URL

Default:
wss://www.cfbenchmarks.com/ws/v4
Nasdaq Indices
wss://nciprod1.cfbenchmarks.com/ws/v4

Authorization

This API requires users to specify an API key. This key can be obtained by contacting CF Benchmarks for a license.

If connecting using Javascript, assuming the key username is 'abc' and the key password is '123', you would connect by specifying the protocol as the array ['cfb', 'abc, '123].

Some language APIs require the key to be specified in the websocket request header. In this case you would provide the username and key in the request header with a header field of the form Authorization: Basic <credentials> where credentials is the Base64 encoding of username and key joined by a single colon ':'.

Commands
Info

The Info endpoint returns details of all streams an API key provides access to.

Example:

{ "type":"info" }

Response:

{
  "type": "info",
  "streams": [
    {
      "id": "ETHUSD_RTI"
    },
    {
      "id": "BRTI"
    },
    {
      "id": "ETHUSD_RR"
    },
    {
      "id": "BRR"
    }
  ]
}
Subscribe
Field Type Description Expected value
type string Command subscribe
id string Stream ID One of the stream IDs above
stream string Stream type One of: [value,constituents]

Example:

{ "type": "subscribe", "id": "BRTI", "stream": "value" }

Note that the constituents streamtype is restricted to the NCIS and NCI indices, and is permissioned on an individual basis. Please contact CF Benchmarks if you require access.

Response:
No direct response if successful. The most recent value will be sent, and subsequent values until the unsubscribe command is sent.

Errors are described below.

Unsubscribe
Field Type Description Expected value
type string Command unsubscribe
id string Stream ID One of the stream IDs above
stream string Stream type One of: [value,constituents]

Example:

{ "type": "unsubscribe", "id": "BRTI", "stream": "value" }

Response:
No direct response if successful. Messages for the subscription will cease.

Errors are described below.

Messages
Value
Field Type Description Expected value
type string Message type value
id string Stream ID One of the stream IDs above
time integer Calculation time of value in milliseconds since Unix epoch
value number Stream value

Example:

{ "type": "value", "id": "BRTI", "value": "8835.56", "time": 1579264280000 }

In addition to the above, each value message may contain any of the following fields:

Field Type Description Expected value
amendTime (Optional) integer If the value has been amended after being previously published, this field indicates the time of the amendment in milliseconds since Unix epoch. If no amendment has been made, the field will not be present.
repeatOfPreviousValue (Optional) boolean If an error has occurred during calculation such that an index value could not be calculated for that day, and it has been replaced with the value from the previous day, this boolean field will exist, and will be true. If no such error has occurred, the field will not be present.

Example:

{ "type": "value", "id": "BRR", "value": "57260.71", "time": 1620313200000, "amendTime": 1620313300000, "repeatOfPreviousValue": true }
Constituents
Field Type Description Expected value
type string Message type constituents
id string Stream ID One of the stream IDs above
time integer Calculation time of value in milliseconds since Unix epoch
value number Index value
divisor number Index divisor
constituents object Object containing constituent name, value, weight and exchange weights

Example:

{
  "type":"constituents",
  "time":1618922805000,
  "id":"NCI",
  "value": "2835.55",
  "divisor": "203484212.3109",
  "constituents":[
    {"constituent": "LINK", "value": "35.0013", "weightPercent": "1.27",
      "exchanges": [
        {"exchange": "exchangeA", "weightPercent": "54.14"},
        {"exchange": "exchangeB", "weightPercent": "20.55"},
        {"exchange": "exchangeC", "weightPercent": "25.31"}
      ]
    },
    {"constituent": "BCH", "value": "793.3554", "weightPercent": "1.03",
      "exchanges": [
        {"exchange": "exchangeA", "weightPercent": "59.38"},
        {"exchange": "exchangeB", "weightPercent": "20.62"},
        {"exchange": "exchangeC", "weightPercent": "20.00"}
      ]
    },
    {"constituent": "ETH", "value": "2454.7451", "weightPercent": "16.86",
      "exchanges": [
        {"exchange": "exchangeA", "weightPercent": "70.43"},
        {"exchange": "exchangeB", "weightPercent": "19.33"},
        {"exchange": "exchangeC", "weightPercent": "10.24"}
      ]
    },
    {"constituent": "XLM", "value": "0.4516", "weightPercent": "0.65",
      "exchanges": [
        {"exchange": "exchangeA", "weightPercent": "40.31"},
        {"exchange": "exchangeB", "weightPercent": "30.45"},
        {"exchange": "exchangeC", "weightPercent": "29.24"}
      ]
    },
    {"constituent": "XBT", "value": "52435.7103", "weightPercent": "78.61",
      "exchanges": [
        {"exchange": "exchangeA", "weightPercent": "9.26"},
        {"exchange": "exchangeB", "weightPercent": "50.32"},
        {"exchange": "exchangeC", "weightPercent": "40.42"}
      ]
    },
    {"constituent": "LTC", "value": "214.3741", "weightPercent": "1.58",
      "exchanges": [
        {"exchange": "exchangeA", "weightPercent": "20.40"},
        {"exchange": "exchangeB", "weightPercent": "39.18"},
        {"exchange": "exchangeC", "weightPercent": "40.42"}
      ]
    }
  ]
}

In addition to the above, each constituents message may contain any of the following fields:

Field Type Description Expected value
amendTime (Optional) integer If the value has been amended after being previously published, this field indicates the time of the amendment in milliseconds since Unix epoch. If no amendment has been made, the field will not be present.
repeatOfPreviousValue (Optional) boolean If an error has occurred during calculation such that an index value could not be calculated for that day, and it has been replaced with the value from the previous day, this boolean field will exist, and will be true. If no such error has occurred, the field will not be present.
Command Errors

Any command that results in an error returns the command with a success flag and a reason for the error.

Field Type Description Expected value
type string Command unsubscribe
id string Stream ID One of the stream IDs above
stream string Stream type One of: [value]
success boolean Was the command successful
reason string Reason for the error

Example:

{ "type": "foo", "id": "BRTI", "stream": "value", "success": false, "reason": "Unrecognised command" }
Great! Check your inbox and click the link to confirm your subscription.
Please enter a valid email address!

This website is provided by CF Benchmarks Ltd. CF Benchmarks Ltd is registered in England with registered number 11654816 and registered office at 6th Floor One London Wall, London, United Kingdom, EC2Y 5EB. CF Benchmarks is authorised and regulated by the UK Financial Conduct Authority as a registered Benchmark Administrator (FRN 847100) under the UK benchmark regulation. No part of this information may be reproduced, stored in a retrieval system or transmitted in any form or by any means, electronic, mechanical, photocopying, recording or otherwise, without prior written permission of CF Benchmarks Ltd. Use and distribution of the CF Benchmarks data requires a license from CF Benchmarks or its authorised licensing agents.

All information is provided for information purposes only. All information and data contained on this website is obtained by CF Benchmarks, from sources believed by it to be accurate and reliable. Such information and data is provided "as is" without warranty of any kind. CF Benchmarks, nor its directors, officers, employees, partners or licensors make any claim, prediction, warranty or representation whatsoever, expressly or implied, either as to the accuracy, timeliness, completeness or merchantability of any information or of results to be obtained from the use of the CF Benchmarks indices or the fitness or suitability of the same indices for any particular purpose to which they might be put. Any representation of historical data accessible through CF Benchmarks indices is provided for information purposes only and is not a reliable indicator of future performance. No responsibility or liability can be accepted by CF Benchmarks nor their respective directors, officers, employees, partners or licensors for any loss or damage in whole or in part caused by, resulting from, or relating to any error (negligent or otherwise) or other circumstance involved in procuring, collecting, compiling, interpreting, analysing, editing, transcribing, transmitting, communicating or delivering any such information or data or from use of this website or links to this website. CF Benchmarks and its respective directors, officers, employees, partners or licensors do not provide investment advice and nothing accessible through CF Benchmarks, should be taken as constituting financial or investment advice or a financial promotion. Charts and graphs are provided for illustrative purposes only. Index returns shown may not represent the results of the actual trading of any assets.

CF Benchmarks is a member of the Crypto Facilities group of companies which is in turn a member of the Payward, Inc. group of companies. Payward, Inc. is the owner and operator of the Kraken Exchange, a venue that facilitates the trading of cryptocurrencies. The Kraken Exchange is a source of input data for CF Benchmarks indices.