ENendclose

Retrieve a data stream

Changed on

Retrieve a data stream using its unique immutable key.

get/data_streams/{key}

Request

  • Base URL
    https://api.endclose.com/v1
  • Auth
    API key in header X-API-KEY

Path parameters

keystring required

The immutable data stream key

Response

Data stream retrieved successfully

idstring uuid

Unique identifier

keystring required

Unique immutable identifier

namestring required

Human readable name

descriptionstring

Optional description of the data stream

typestring

The type of data stream (e.g. api, csv, stripe, bank_feed). adjustments is a stream End Close writes itself: a reconciliation's adjustment records for one side, bound to that reconciliation alone.

program_idstring uuid nullable
records_countinteger

Record count from the ClickHouse mirror

Changes

  • 159f9ed3dbf4Revision changes
    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status

    • breaking

      the response's property type changed from integer to string, and format from no format to uuid for status

  • fb02f944f95eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status