You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Databento .NET Client - Complete API Classification
Version: 4.3.0
Generated: 2025-11-28
This document provides a comprehensive classification of every API call available in the databento-dotnet library, including input parameters and expected outputs. This library wraps databento-cpp (Databento's C++ client library) for .NET consumption.
Pull next record. Returns null on timeout. Use Timeout.InfiniteTimeSpan for no timeout.
ReconnectAsync
cancellationToken: CancellationToken = default
Task
Reconnect to gateway
ResubscribeAsync
cancellationToken: CancellationToken = default
Task
Resubscribe to stored subscriptions
StopAsync
cancellationToken: CancellationToken = default
Task
Stop the stream
3. Data Models
3.1 Record Types
All record types inherit from the base Record class:
publicabstractclassRecord{publiclongTimestampNs{get;set;}// Timestamp in nanoseconds since Unix epochpublicbyteRType{get;set;}// Record type identifierpublicushortPublisherId{get;set;}// Publisher IDpublicuintInstrumentId{get;set;}// Instrument IDpublicDateTimeOffsetTimestamp{get;}// Convenience property (derived from TimestampNs)internalbyte[]?RawBytes{get;set;}// Raw DBN bytes for serialization}
TradeMessage
Size: 48 bytes | RType: 0x00 | Schema:trades
Property
Type
Description
Price
long
Trade price (fixed-point, 9 decimal places)
Size
uint
Trade size (volume)
Action
Action
Trade action (Trade, Fill, etc.)
Side
Side
Trade side (Bid, Ask, None)
Flags
byte
Trade flags
Depth
byte
Trade depth
Sequence
uint
Sequence number
PriceDecimal
decimal
Convenience: Price / 1,000,000,000
MboMessage
Size: 56 bytes | RType: 0xA0 | Schema:mbo
Property
Type
Description
OrderId
ulong
Order ID
Price
long
Order price (fixed-point)
Size
uint
Order size
Flags
byte
Order flags
ChannelId
byte
Channel ID
Action
Action
Order action (Add, Modify, Cancel, Trade, Fill, Clear)
Trade with Consolidated BBO - same structure as Cmbp1Message.
3.2 Supporting Structures
BidAskPair (32 bytes)
Property
Type
Description
BidPrice
long
Bid price (fixed-point)
AskPrice
long
Ask price (fixed-point)
BidSize
uint
Bid size
AskSize
uint
Ask size
BidCount
uint
Bid order count
AskCount
uint
Ask order count
ConsolidatedBidAskPair (32 bytes)
Property
Type
Description
BidPrice
long
Bid price (fixed-point)
AskPrice
long
Ask price (fixed-point)
BidSize
uint
Bid size
AskSize
uint
Ask size
BidPublisher
ushort
Bid publisher ID
AskPublisher
ushort
Ask publisher ID
DbnMetadata
Property
Type
Description
Version
byte
DBN version
Dataset
string
Dataset name
Schema
Schema
Schema type
Start
DateTimeOffset
Start time
End
DateTimeOffset
End time
Limit
ulong?
Record limit
StypeIn
SType
Input symbology type
StypeOut
SType
Output symbology type
Symbols
string[]
Symbols array
MappingsCount
int
Number of symbol mappings
4. Enumerations
Schema
Value
Code
API String
Description
Mbo
0
mbo
Market by order (full order book)
Mbp1
1
mbp-1
Market by price level 1 (top of book)
Mbp10
2
mbp-10
Market by price level 10 (10 levels)
Tbbo
3
tbbo
Trades with BBO
Trades
4
trades
All trades
Ohlcv1S
5
ohlcv-1s
OHLCV 1 second bars
Ohlcv1M
6
ohlcv-1m
OHLCV 1 minute bars
Ohlcv1H
7
ohlcv-1h
OHLCV 1 hour bars
Ohlcv1D
8
ohlcv-1d
OHLCV 1 day bars (UTC)
Definition
9
definition
Instrument definitions
Statistics
10
statistics
Market statistics
Status
11
status
Trading status events
Imbalance
12
imbalance
Auction imbalances
OhlcvEod
13
ohlcv-eod
OHLCV end of day (session-based)
Cmbp1
14
cmbp-1
Consolidated MBP-1
Cbbo1S
15
cbbo-1s
Consolidated BBO 1 second
Cbbo1M
16
cbbo-1m
Consolidated BBO 1 minute
Tcbbo
17
tcbbo
Trades with consolidated BBO
Bbo1S
18
bbo-1s
BBO 1 second
Bbo1M
19
bbo-1m
BBO 1 minute
SType (Symbology Type)
Value
Code
API String
Description
InstrumentId
0
instrument_id
Numeric instrument ID
RawSymbol
1
raw_symbol
Raw exchange symbol
Smart
2
smart
Smart routing
Continuous
3
continuous
Continuous contracts (e.g., ES.c.0)
Parent
4
parent
Parent symbol
NasdaqSymbol
5
nasdaq_symbol
NASDAQ symbol
CmsSymbol
6
cms_symbol
CMS symbol
Isin
7
isin
ISIN identifier
UsCode
8
us_code
US code
BbgCompId
9
bbg_comp_id
Bloomberg company ID
BbgCompTicker
10
bbg_comp_ticker
Bloomberg ticker
Figi
11
figi
FIGI identifier
FigiTicker
12
figi_ticker
FIGI ticker
Side
Value
Code
Description
Ask
'A' (65)
Ask/offer side
Bid
'B' (66)
Bid side
None
'N' (78)
No side
Action
Value
Code
Description
Modify
'M' (77)
Order modification
Trade
'T' (84)
Trade execution
Fill
'F' (70)
Order fill
Cancel
'C' (67)
Order cancellation
Add
'A' (65)
Order addition
Clear
'R' (82)
Clear/reset
None
'N' (78)
No action
InstrumentClass
Value
Code
Description
Unknown
0
Unknown
Bond
'B' (66)
Bond
Call
'C' (67)
Call option
Future
'F' (70)
Future
Stock
'K' (75)
Stock
MixedSpread
'M' (77)
Mixed spread
Put
'P' (80)
Put option
FutureSpread
'S' (83)
Future spread
OptionSpread
'T' (84)
Option spread
FxSpot
'X' (88)
FX spot
CommoditySpot
'Y' (89)
Commodity spot
MatchAlgorithm
Value
Code
Description
Undefined
'0' (48)
Undefined
Fifo
'F' (70)
First in, first out
Configurable
'K' (75)
Configurable
ProRata
'C' (67)
Pro-rata allocation
FifoLmm
'T' (84)
FIFO with lead market maker
ThresholdProRata
'O' (79)
Threshold pro-rata
FifoTopLmm
'S' (83)
FIFO top with LMM
ThresholdProRataLmm
'Q' (81)
Threshold pro-rata with LMM
Eurodollar
'Y' (89)
Eurodollar
StatusAction
Value
Code
Description
None
0
No action
PreOpen
1
Pre-open
PreCross
2
Pre-cross
Quoting
3
Quoting
Cross
4
Cross
Rotation
5
Rotation
NewPriceIndication
6
New price indication
Trading
7
Trading
Halt
8
Halt
Pause
9
Pause
Suspend
10
Suspend
PreClose
11
Pre-close
Close
12
Close
PostClose
13
Post-close
Closed
14
Closed
PrivateAuction
200
Private auction
StatusReason
Value
Code
Description
None
0
No reason
Scheduled
1
Scheduled
SurveillanceIntervention
2
Surveillance intervention
MarketEvent
3
Market event
InstrumentActivation
4
Instrument activation
InstrumentExpiration
5
Instrument expiration
Recovery
6
Recovery
Compliance
7
Compliance
Regulatory
8
Regulatory
AdministrativeEnd
9
Administrative end
AdministrativeSuspend
10
Administrative suspend
NotAvailable
11
Not available
ErrorCode
Value
Code
Description
AuthFailed
1
Authentication failed
ApiKeyDeactivated
2
API key deactivated
ConnectionLimitExceeded
3
Connection limit exceeded
SymbolResolutionFailed
4
Symbol resolution failed
InvalidSubscription
5
Invalid subscription
InternalError
6
Internal gateway error
Unset
255
No error code specified
SystemCode
Value
Code
Description
Heartbeat
0
Connection heartbeat
SubscriptionAck
1
Subscription acknowledged
SlowReaderWarning
2
Slow reader warning
ReplayCompleted
3
Replay caught up with real-time
EndOfInterval
4
End of interval signal
Unset
255
No system code specified
Configuration Enums
HistoricalGateway
Value
Description
Bo1
Primary gateway (bo1.databento.com)
Bo2
Secondary gateway (bo2.databento.com)
Custom
Custom gateway address
VersionUpgradePolicy
Value
Description
AsIs
Keep original DBN version
Upgrade
Upgrade to latest DBN version
Encoding
Value
API String
Description
Dbn
dbn
Databento Binary Encoding
Csv
csv
Comma-separated values
Json
json
JSON format
Compression
Value
API String
Description
None
none
No compression
Zstd
zstd
Zstandard compression
Gzip
gzip
Gzip compression
SplitDuration
Value
API String
Description
None
none
No splitting
Day
day
Split by day
Week
week
Split by week
Month
month
Split by month
Delivery
Value
Description
Download
Direct download
S3
AWS S3 delivery
Disk
Local disk
JobState
Value
API String
Description
Received
received
Job received
Queued
queued
Job queued
Processing
processing
Job processing
Done
done
Job completed
Expired
expired
Job expired
DatasetCondition
Value
API String
Description
Available
available
Dataset available
Degraded
degraded
Degraded availability
Pending
pending
Availability pending
Missing
missing
Dataset missing
RType (Record Type Identifier)
Critical enum for DBN binary protocol message routing. Values match databento-cpp enums.hpp.
Value
Code (Hex)
Description
Mbp0
0x00
Trade messages
Mbp1
0x01
Market by Price Level 1
Mbp10
0x0A
Market by Price Level 10
OhlcvDeprecated
0x11
Deprecated OHLCV format
Status
0x12
Trading status messages
InstrumentDef
0x13
Instrument definitions
Imbalance
0x14
Order imbalances
Error
0x15
Error messages
SymbolMapping
0x16
Symbol mapping messages
System
0x17
System messages / heartbeats
Statistics
0x18
Market statistics
Ohlcv1S
0x20
OHLCV 1 second bars
Ohlcv1M
0x21
OHLCV 1 minute bars
Ohlcv1H
0x22
OHLCV 1 hour bars
Ohlcv1D
0x23
OHLCV 1 day bars
OhlcvEod
0x24
OHLCV end of day bars
Mbo
0xA0
Market by Order (full order book)
Cmbp1
0xB1
Consolidated Market by Price Level 1
Cbbo1S
0xC0
Consolidated BBO 1 second
Cbbo1M
0xC1
Consolidated BBO 1 minute
Tcbbo
0xC2
Trade with Consolidated BBO
Bbo1S
0xC3
BBO 1 second
Bbo1M
0xC4
BBO 1 minute
TradingEvent
Value
Code
Description
None
0
No trading event
NoCancel
1
No cancel period
ChangeTradingSession
2
Trading session change
ImpliedMatchingOn
3
Implied matching enabled
ImpliedMatchingOff
4
Implied matching disabled
TriState
Value
Code
Description
NotAvailable
'~' (126)
Value not available
No
'N' (78)
No / False
Yes
'Y' (89)
Yes / True
UserDefinedInstrument
Value
Code
Description
No
'N' (78)
Not user-defined
Yes
'Y' (89)
User-defined instrument
SecurityUpdateAction
Value
Code
Description
Add
'A' (65)
Security added
Modify
'M' (77)
Security modified
Delete
'D' (68)
Security deleted
PricingMode
Value
Code
Description
Historical
0
Historical batch data pricing
HistoricalStreaming
1
Historical streaming data pricing
Live
2
Live streaming data pricing
ConnectionState
Value
Description
Disconnected
Not connected to gateway
Connecting
Connecting to gateway
Connected
Connected and authenticated
Streaming
Actively streaming data
Reconnecting
Reconnecting after disconnection
Stopped
Stopped by user
ExceptionAction
Value
Description
Continue
Continue processing after the exception
Stop
Stop streaming and clean up
5. Builder Classes
HistoricalClientBuilder
Method
Parameter
Type
Required
Default
Description
WithApiKey
apiKey
string
Yes*
-
Databento API key
WithKeyFromEnv
-
-
Yes*
-
Set API key from DATABENTO_API_KEY env var
WithGateway
gateway
HistoricalGateway
No
Bo1
API gateway selection
WithAddress
host, port
string, ushort
No
-
Custom gateway address (sets gateway to Custom)
WithUpgradePolicy
policy
VersionUpgradePolicy
No
Upgrade
DBN version upgrade policy
WithUserAgent
userAgent
string
No
-
Additional user agent string
WithTimeout
timeout
TimeSpan
No
30 seconds
Request timeout (must be positive)
WithLogger
logger
ILogger<IHistoricalClient>
No
-
Logger for diagnostics
Build
-
-
-
-
Returns IHistoricalClient
*One of WithApiKey or WithKeyFromEnv is required.
LiveClientBuilder
Method
Parameter
Type
Required
Default
Description
WithApiKey
apiKey
string
Yes*
-
Databento API key
WithKeyFromEnv
-
-
Yes*
-
Set API key from DATABENTO_API_KEY env var
WithDataset
dataset
string
No
-
Default dataset for subscriptions
WithSendTsOut
sendTsOut
bool
No
false
Include ts_out timestamps in records
WithUpgradePolicy
policy
VersionUpgradePolicy
No
Upgrade
DBN version upgrade policy
WithHeartbeatInterval
interval
TimeSpan
No
30 seconds
Heartbeat interval (must be positive)
WithLogger
logger
ILogger<ILiveClient>
No
-
Logger for diagnostics
WithExceptionHandler
handler
ExceptionCallback
No
-
Exception handler for streaming errors
WithAutoReconnect
enabled
bool
No
false
Enable automatic reconnection on failure
WithRetryPolicy
policy
RetryPolicy
No
Default
Configure retry behavior for connections
WithHeartbeatTimeout
timeout
TimeSpan
No
90 seconds
Stale connection detection timeout
WithResilienceOptions
options
ResilienceOptions
No
-
Full resilience configuration
Build
-
-
-
-
Returns ILiveClient
*One of WithApiKey or WithKeyFromEnv is required.
LiveBlockingClientBuilder
Method
Parameter
Type
Required
Default
Description
WithApiKey
apiKey
string
Yes*
-
Databento API key
WithKeyFromEnv
-
-
Yes*
-
Set API key from DATABENTO_API_KEY env var
WithDataset
dataset
string
Yes
-
Dataset for connection (native library requirement)
WithSendTsOut
sendTsOut
bool
No
false
Include ts_out timestamps in records
WithUpgradePolicy
policy
VersionUpgradePolicy
No
Upgrade
DBN version upgrade policy
WithHeartbeatInterval
interval
TimeSpan
No
30 seconds
Heartbeat interval (must be positive)
WithLogger
logger
ILogger<ILiveBlockingClient>
No
-
Logger for diagnostics
Build
-
-
-
-
Returns ILiveBlockingClient
*One of WithApiKey or WithKeyFromEnv is required.
ReferenceClientBuilder
Method
Parameter
Type
Required
Default
Description
WithApiKey
apiKey
string
Yes*
-
Databento API key
WithKeyFromEnv
-
-
Yes*
-
Set API key from DATABENTO_API_KEY env var
WithGateway
gateway
HistoricalGateway
No
Bo1
API gateway selection
WithLogger
logger
ILogger<IReferenceClient>
No
-
Logger for diagnostics
WithHttpClient
httpClient
HttpClient
No
-
Pre-configured HttpClient (e.g., from IHttpClientFactory)
Build
-
-
-
-
Returns IReferenceClient
*One of WithApiKey or WithKeyFromEnv is required (or the DATABENTO_API_KEY env var must be set).
5.1 ReferenceClient
Interface:IReferenceClientImplementation:ReferenceClientPurpose: Query reference data including corporate actions, adjustment factors, and security master data
Lifecycle:IAsyncDisposable