Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
ChartingController
  • /api/v0/charting/dx-query
  • /api/v0/charting/dx/stopCharting
  • /api/v0/charting/dx/{streamKey}
  • /api/v0/charting/settings/barPeriodicities
  • /api/v0/charting/{streamKey}/settings/linear-chart-columns
  • POST
  • GET
  • GET
  • GET
  • GET
FlowchartController
  • /api/v0/flowchart
  • GET
GenAiController
  • /api/v0/genai/ddlgen
  • /api/v0/genai/qqlgen
  • POST
  • POST
GrafanaController
  • /grafana/v0
  • /grafana/v0/groupByViewOptions
  • /grafana/v0/schema
  • /grafana/v0/streams
  • /grafana/v0/symbols
  • /grafana/v0/queries/select
  • /grafana/v0/queries/selectDF
  • /grafana/v0/queries/selectTS
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
ImportCsvController
  • /api/v0/import/cancel/{id}
  • /api/v0/import/csv/init
  • /api/v0/import/finish/{id}
  • /api/v0/import/csv/getPreview/{id}
  • /api/v0/import/csv/headers/{id}
  • /api/v0/import/csv/log/{id}
  • /api/v0/import/csv/mapping/{id}
  • /api/v0/import/csv/preview/{id}
  • /api/v0/import/csv/requestProcess/{id}
  • /api/v0/import/csv/schema/{id}
  • /api/v0/import/csv/setting/{id}
  • /api/v0/import/csv/uploadChunk/{id}
  • /api/v0/import/csv/validate/{id}
  • /api/v0/import/csv/validate/mapping/{id}
  • POST
  • POST
  • POST
  • POST
  • GET
  • GET
  • POST
  • DELETE POST
  • POST
  • GET
  • GET POST
  • POST
  • POST
  • POST
Default controller for REST API
ImportQsmsgController
  • /api/v0/initImport
  • /api/v0/cancelImport/{id}
  • /api/v0/importChunk/{id}
  • /api/v0/import/schema/{id}
  • /api/v0/import/validateSchema/{id}/{stream}
  • POST
  • POST
  • POST
  • GET
  • GET
Default controller for REST API
InfoController
  • /api/v0/authInfo
  • /api/v0/docs
  • /api/v0/writable
  • GET
  • GET
  • GET
PingController
  • /ping
  • GET
Ping Controller
PlaybackController
  • /api/v0/playback
  • /api/v0/playback/close
  • /api/v0/playback/pause
  • /api/v0/playback/permanent
  • /api/v0/playback/play
  • /api/v0/playback/resume
  • /api/v0/playback/skip
  • /api/v0/playback/speed
  • /api/v0/playback/stop
  • GET POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • POST
TimeBaseTreeController
  • /api/v0/structure
  • /api/v0/structure/{stream}/{symbol}
  • POST
  • POST
TimebaseController
  • /api/v0/
  • /api/v0/availableSources
  • /api/v0/compileQuery
  • /api/v0/correlationId
  • /api/v0/createStream
  • /api/v0/currencies
  • /api/v0/datatypes
  • /api/v0/describe
  • /api/v0/download
  • /api/v0/export
  • /api/v0/export-query
  • /api/v0/login
  • /api/v0/logout
  • /api/v0/order-book
  • /api/v0/query
  • /api/v0/schema
  • /api/v0/select
  • /api/v0/settings
  • /api/v0/streams
  • /api/v0/unlimitedQuery
  • /api/v0/v
  • /api/v0/query-info/functions
  • /api/v0/query-info/functions-short
  • /api/v0/{streamId}/abortBackgroundTask
  • /api/v0/{streamId}/changeSchema
  • /api/v0/{streamId}/delete
  • /api/v0/{streamId}/deleteData
  • /api/v0/{streamId}/deleteSpace
  • /api/v0/{streamId}/deleteSymbols
  • /api/v0/{streamId}/describe
  • /api/v0/{streamId}/export
  • /api/v0/{streamId}/filter
  • /api/v0/{streamId}/getSchemaChanges
  • /api/v0/{streamId}/options
  • /api/v0/{streamId}/purge
  • /api/v0/{streamId}/range
  • /api/v0/{streamId}/rename
  • /api/v0/{streamId}/renameSpace
  • /api/v0/{streamId}/schema
  • /api/v0/{streamId}/select
  • /api/v0/{streamId}/setPeriodicity
  • /api/v0/{streamId}/spaces
  • /api/v0/{streamId}/symbols
  • /api/v0/{streamId}/truncate
  • /api/v0/{streamId}/update
  • /api/v0/{streamId}/write
  • /api/v0/instruments/{id}/info
  • /api/v0/validate/stream/key
  • /api/v0/{streamId}/options/backgroundTask
  • /api/v0/{streamId}/options/{symbolId}
  • /api/v0/{streamId}/{symbolId}/select
  • /api/v0/{streamId}/{symbol}/rename
  • GET POST
  • GET
  • POST
  • GET
  • POST
  • GET
  • GET
  • POST
  • GET
  • GET POST
  • POST
  • POST
  • POST
  • GET POST
  • POST
  • GET
  • GET POST
  • GET
  • GET
  • POST
  • GET POST
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
  • GET
  • POST
  • GET
  • GET POST
  • POST
  • POST
  • GET PUT
  • POST
  • GET
  • POST
  • GET
  • GET
  • GET POST
  • POST
  • GET
  • GET
  • POST
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET POST
  • POST
Default controller for REST API
TopicController
  • /api/v0/topics
  • /api/v0/topics/structure
  • /api/v0/topics/{topicId}
  • /api/v0/topics/{topicId}/schema
  • /api/v0/topics/{topicId}/rename/{newTopicId}
  • GET POST
  • POST
  • DELETE
  • GET
  • POST
ViewController
  • /api/v0/timebase/views
  • /api/v0/timebase/views/{viewId}
  • /api/v0/timebase/views/{viewId}/pause
  • /api/v0/timebase/views/{viewId}/restart
  • /api/v0/timebase/views/{viewId}/resume
  • /api/v0/timebase/views/{viewId}/start
  • /api/v0/timebase/views/{viewId}/stop
  • GET POST
  • DELETE GET
  • PUT
  • PUT
  • PUT
  • PUT
  • PUT