credmark.cmf.types.ledger_series.LedgerBlockTimeSeriesInput

DTO class LedgerBlockTimeSeriesInput(*, endTimestamp, interval, count, exclusive=False)

Bases: BaseModel

Input for the ledger.block-time-series model.

Show JSON schema

{
   "title": "LedgerBlockTimeSeriesInput",
   "description": "Input for the ledger.block-time-series model.",
   "type": "object",
   "properties": {
      "endTimestamp": {
         "title": "Endtimestamp",
         "description": "End timestamp of block series, inclusive unless exclusive is True",
         "type": "integer"
      },
      "interval": {
         "title": "Interval",
         "description": "Series interval in seconds",
         "type": "integer"
      },
      "count": {
         "title": "Count",
         "description": "Number of intervals in the series.",
         "type": "integer"
      },
      "exclusive": {
         "title": "Exclusive",
         "description": "If true, blocks are exclusive of end timestamp",
         "default": false,
         "type": "boolean"
      }
   },
   "required": [
      "endTimestamp",
      "interval",
      "count"
   ]
}

Fields

• count (int)

• endTimestamp (int)

• exclusive (Optional[bool])

• interval (int)

Parameters

• endTimestamp (int) –

• interval (int) –

• count (int) –

• exclusive (Optional[bool]) –

Return type

None

field count: int [Required]

Number of intervals in the series.

field endTimestamp: int [Required]

End timestamp of block series, inclusive unless exclusive is True

field exclusive: Optional[bool] = False

If true, blocks are exclusive of end timestamp

field interval: int [Required]

Series interval in seconds