Skip to main content
POST
/
data_streams
Create a data stream
curl --request POST \
  --url https://api.endclose.com/v1/data_streams \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "key": "<string>",
  "name": "<string>",
  "type": "api",
  "bank_account_id": "<string>"
}
'
{
  "key": "<string>",
  "name": "<string>",
  "id": 123,
  "description": "<string>",
  "type": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
key
string
required

Unique immutable identifier

​
name
string
required

Human readable name

​
type
enum<string>
default:api

The type of data stream to create

Available options:
api,
bank_feed
​
bank_account_id
string

Required when type is bank_feed. The ID of the bank account to link.

Response

Data stream created

​
key
string
required

Unique immutable identifier

​
name
string
required

Human readable name

​
id
integer

Unique numeric identifier

​
description
string

Optional description of the data stream

​
type
string

The type of data stream (e.g. api, csv, stripe, bank_feed)