Timebase Web Gateway

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/{streamKey}
  • /api/v0/charting/dx/stopCharting
  • /api/v0/charting/dx/{streamKey}
  • /api/v0/charting/settings/barPeriodicities
  • POST
  • GET
  • GET
  • GET
  • GET
FlowchartController
  • /api/v0/flowchart
  • GET
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
InfoController
  • /api/v0/authInfo
  • /api/v0/docs
  • /api/v0/writable
  • GET
  • GET
  • GET
PingController
  • /ping
  • GET
Ping Controller
TimeBaseTreeController
  • /api/v0/structure
  • POST
TimebaseController
  • /api/v0/
  • /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/query
  • /api/v0/select
  • /api/v0/settings
  • /api/v0/startImport
  • /api/v0/streams
  • /api/v0/v
  • /api/v0/cancelImport/{id}
  • /api/v0/importChunk/{id}
  • /api/v0/instruments/{id}
  • /api/v0/query-info/functions
  • /api/v0/query-info/functions-short
  • /api/v0/{streamId}/changeSchema
  • /api/v0/{streamId}/delete
  • /api/v0/{streamId}/deleteSpace
  • /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}/write
  • /api/v0/{streamId}/options/{symbolId}
  • /api/v0/{streamId}/{symbolId}/select
  • /api/v0/{streamId}/{symbol}/rename
  • GET POST
  • POST
  • GET
  • POST
  • GET
  • GET
  • POST
  • GET
  • GET POST
  • POST
  • POST
  • GET POST
  • GET
  • POST
  • GET
  • GET POST
  • POST
  • POST
  • GET
  • GET
  • GET
  • POST
  • POST
  • GET
  • GET
  • GET POST
  • POST
  • POST
  • GET
  • POST
  • GET
  • POST
  • GET
  • GET
  • GET POST
  • POST
  • GET
  • GET
  • POST
  • POST
  • GET
  • GET POST
  • POST
Default controller for REST API

Data Types

JSON

type description
AggregationInfo
AggregationInterval
AppSettingDef Created by Alex Karpovich on 10/01/2020.
ArgumentType
Attribute
AuthInfo Provides authentication info.
BBOElementDef A definition of a base line point.
BarElementDef A definition of a base line point.
BarPeriodicity
BaseLinePoint A definition of a base line point.
BaseRequest Request for downloading data from server.
BufferOptions
CSVExporter
ChangeSchemaRequest
ChannelCompression
ChannelPerformance
ChannelPreferences
ChannelQualityOfService
CharSequence
ChartType
ChartingFrame The container for charting getQuery result.
ChartingLineDef The charting data for a line.
ClassDescriptorChangeDef
Column
CommonOptions
CompileResult Created by Alex Karpovich on 08/04/2021.
ConstantArgumentDef
ContentType
CurrencyDef Created by Alex Karpovich on 09/01/2020.
DataFrame
DataQuery
DataQueryRequestOfSelectQuery
DataTypeDef Created by Alex Karpovich on 13/11/2020.
DescribeResponse
DownloadId
DynamicList
ErrorLocation Created by Alex Karpovich on 10/06/2021.
ExecutionTag A line point that defines an execution tag.
ExportFormat Created by Alex Karpovich on 22/06/2021.
ExportMode Created by Alex Karpovich on 22/06/2021.
ExportRequest
ExportStreamsRequest
FieldArg
FieldArgumentDef
FieldChangeWrapper
FieldDef Schema field definition.
FieldFilter
FieldInfo
FieldMapping
FieldType
FileResponseBody
FilterRequest Request for downloading data from server.
FilterType
FunctionDef
FunctionDef
GrafanaFunctionDef
GrafanaVersion
HTML
Impact
ImportRequest
InstrumentDef
InstrumentRequest Request for selecting data from specified stream using specified symbol.
IntervalType
LineElement A definition of a line element.
LinePoint A definition of a line point.
MessageSource2QMSGFile
MessageSource2ResponseStream
PeriodicityDef Created by Alex Karpovich on 16/12/2019.
PeriodicityRequest
ProviderType
QueryRequest Request for selecting data from specified stream using QQL/DDL getQuery.
QuoteSide
RawElementDef A definition of a base line point.
RawFilter
RawTimeRange
ReturnFieldDef
SchemaChangesRequest
SchemaDef Stream schema definition
SchemaMappingDef
SelectQuery Select query, that allows selecting separate fields, filtering by plain fields (not arrays, objects and binaries) and aggregations by time interval.
SelectRequest Request for selecting data from streams.
SelectionOptions
SimpleRequest Base Request for the operations with stream.
StreamDef Created by Alex Karpovich on 9/10/2018.
StreamExporter
StreamMetaDataChangeDef
StreamOptionsDef Created by Alex Karpovich on 4/29/2019.
StreamRequest Request for selecting data from specified stream.
StreamSchema
StreamScope
StreamTreeNodeDef
StreamingResponseBody
SymbolOptions
TBField
TBQuery
Tag A line point that defines a tag.
Tag
TagType Type of tag.
TimeBaseStructureRequestDef
TimeRange
TimeRangeDef Time range definition.
TimeSeriesEntry
TimeUnit
TimebaseField
Token
TokenType
TreeNodeDef
Type
TypeDef Schema type description.
TypeInfo
TypeLoader
TypeSelection Created by Alex Karpovich on 22/06/2021.
ValueType
VersionDef API Version information.
View

XML

Default Namespace
type description
downloadId
streamDef Created by Alex Karpovich on 9/10/2018.
chartType
ChartingFrame The container for charting getQuery result.
dataQuery
dataQueryRequest
selectQuery Select query, that allows selecting separate fields, filtering by plain fields (not arrays, objects and binaries) and aggregations by time interval.
TBQuery
rawTimeRange
timeRange
baseRequest Request for downloading data from server.
exportFormat Created by Alex Karpovich on 22/06/2021.
exportMode Created by Alex Karpovich on 22/06/2021.
exportRequest
exportStreamsRequest
filterRequest Request for downloading data from server.
importRequest
instrumentRequest Request for selecting data from specified stream using specified symbol.
periodicityRequest
queryRequest Request for selecting data from specified stream using QQL/DDL getQuery.
selectRequest Request for selecting data from streams.
simpleRequest Base Request for the operations with stream.
streamRequest Request for selecting data from specified stream.
typeSelection Created by Alex Karpovich on 22/06/2021.
functionDef
changeSchemaRequest
dataTypeDef Created by Alex Karpovich on 13/11/2020.
fieldDef Schema field definition.
schemaChangesRequest
schemaDef Stream schema definition
schemaMappingDef
fieldMapping
typeDef Schema type description.
barPeriodicity
CSVExporter
fileResponseBody
messageSource2QMSGFile
streamExporter
messageSource2ResponseStream
type
timeUnit
instant
HTML
streamingResponseBody