Monitor the overall performance of specific buckets of assets. The indices combine several data sources to summarize market performance. They can be used to aid the issuance of derivatives contracts or investment vehicles by providing pricing for settlement. You can see our full list of indices and learn more about their performance in our .
Requesting multiple tickers at the same time
To configure multiple tickers in the same stream, provide the indexCode as a comma-separated list eg KT5,KT10NYC
Alternatively, use a wildcard by entering a * and you'll receive all tickers you have as part of your Kaiko subscription.
Fields
Field
Description
indexCode
The ticker identifying the index.
commodity
The type of publication. Either real-time or fixings
interval
The time period in which transaction data are considered for the calculation of the index. If an index's calculation methodology has an interval of 15 seconds, startTime and endTime will be separated by 15s.
mainQuote
is the quote asset used for the index denomination.
compositions
The list of underlying data used to calculate the index price.
underlyingInstrument
The ticker for the Kaiko Reference Rate(s) used to calculate the multi-asset index.
base
The base asset for the used Reference Rate.
quote
The quote asset for the used Reference Rate
Exchanges
The exchanges used to calculate the Reference Rate.
insturmentInterval
The startTime and endTime of the calculation period for the specific Reference Rate.
tsEvent
The time the rate was published by Kaiko.
price
Information on the pricing for the index.
indexValue
The value for the index publication.
pairs
The pricing details of the underlying Kaiko Reference Rates used in the calculation.
underlyingPrice
The published price of the Reference Rate.
weightingFactor
The weighting of the Reference Rate to the index.
cappingFactor
The capping of the Reference Rate to the index.
currencyConversionFactor
The conversion factor used in the Reference Rate for the index.
tsEvent
The theoretical time of price publication
tsCompute
The exact time of price computation.
Request examples
Make sure to read our Python quick-start guide before starting.
# This is a code example. Configure your parameters in the parameter configuration section #
from __future__ import print_function
import logging
import os
import grpc
from google.protobuf.json_format import MessageToJson
from google.protobuf import duration_pb2
from kaikosdk import sdk_pb2_grpc
from kaikosdk.core import instrument_criteria_pb2, assets_pb2
from kaikosdk.stream.aggregates_ohlcv_v1 import request_pb2 as pb_ohlcv
from kaikosdk.stream.aggregates_vwap_v1 import request_pb2 as pb_vwap
from kaikosdk.stream.market_update_v1 import request_pb2 as pb_market_update
from kaikosdk.stream.market_update_v1 import commodity_pb2 as pb_commodity
from kaikosdk.stream.trades_v1 import request_pb2 as pb_trades
from kaikosdk.stream.index_v1 import request_pb2 as pb_index
from kaikosdk.stream.index_multi_assets_v1 import request_pb2 as pb_index_multi_assets
from kaikosdk.stream.index_forex_rate_v1 import request_pb2 as pb_index_forex_rate
from kaikosdk.stream.aggregated_quote_v2 import request_pb2 as pb_aggregated_quote
from kaikosdk.stream.aggregates_spot_exchange_rate_v2 import request_pb2 as pb_spot_exchange_rate
from kaikosdk.stream.aggregates_direct_exchange_rate_v2 import request_pb2 as pb_direct_exchange_rate
def index_multi_asset(channel: grpc.Channel):
try:
with channel:
stub = sdk_pb2_grpc.StreamIndexMultiAssetsServiceV1Stub(channel)
responses = stub.Subscribe(pb_index_multi_assets.StreamIndexMultiAssetsServiceRequestV1(
index_code = "KT5"
))
for response in responses:
print("Received message %s" % (MessageToJson(response, including_default_value_fields = True)))
# print("Received message %s" % list(map(lambda o: o.string_value, response.data.values)))
except grpc.RpcError as e:
print(e.details(), e.code())
def run():
credentials = grpc.ssl_channel_credentials(root_certificates=None)
call_credentials = grpc.access_token_call_credentials(os.environ['KAIKO_API_KEY'])
composite_credentials = grpc.composite_channel_credentials(credentials, call_credentials)
channel = grpc.secure_channel('gateway-v0-grpc.kaiko.ovh', composite_credentials)
index_multi_asset(channel)
if __name__ == '__main__':
logging.basicConfig()
run()
This example demonstrates how to request historical data using replay. The maximum amount of data you can request for one replay cannot exceed a total of 24 hours in hours, seconds, and minutes.
Replay data is available on a 72-hour rolling basis and should only be used to retrieve missed data. If full history is required, please use Rest API or CSV deployment methods.
# This is a code example. Configure your parameters below #
from __future__ import print_function
import logging
import os
import datetime
import grpc
from google.protobuf.json_format import MessageToJson
from kaikosdk import sdk_pb2_grpc
from kaikosdk.stream.index_multi_assets_v1 import request_pb2 as pb_index_multi_assets
from google.protobuf.timestamp_pb2 import Timestamp
api_key = os.environ.get('KAIKO_API_KEY')
def index_multi_asset(channel: grpc.Channel, index_code, start_unix, end_unix):
k = []
try:
with channel:
stub = sdk_pb2_grpc.StreamIndexMultiAssetsServiceV1Stub(channel)
responses = stub.Subscribe(pb_index_multi_assets.StreamIndexMultiAssetsServiceRequestV1(
index_code=index_code,
interval={
'start_time': Timestamp(seconds=start_unix),
'end_time': Timestamp(seconds=end_unix)
}
))
if os.path.exists('index_replay_logging.txt'):
os.remove('index_replay_logging.txt')
print("index_replay_logging.txt Removed!")
for response in responses:
# print("Received message %s" % (MessageToJson(response, including_default_value_fields=True)))
k += [eval(MessageToJson(response))]
except grpc.RpcError as e:
print(e.details(), e.code())
print("replay is done!")
return k
def run(start_time, end_time, index_list):
credentials = grpc.ssl_channel_credentials(root_certificates=None)
call_credentials = grpc.access_token_call_credentials(api_key)
composite_credentials = grpc.composite_channel_credentials(credentials, call_credentials)
channel = grpc.secure_channel('gateway-v0-grpc.kaiko.ovh', composite_credentials)
res = index_multi_asset(channel=channel,
index_code=','.join(index_list),
start_unix=start_time,
end_unix=end_time)
# print(res)
return res
if __name__ == '__main__':
logging.basicConfig()
current_time = datetime.datetime.now()
current_time = current_time.replace(second=0, microsecond=0)
# start of time configuration #
start_time = current_time - datetime.timedelta(minutes=15)
end_time = current_time - datetime.timedelta(minutes=5)
# start of time configuration #
start_time = int(start_time.timestamp())
end_time = int(end_time.timestamp())
# add your index code(s) #
res = run(start_time=start_time, end_time=end_time, index_list = ['KT5'])
print(res)
cURL requests are intended for testing purposes only.
