HomeGuidesAPI Reference
API Reference

Create a data rule

post
https://example.com/data/rules

Create a new data rule that maps an asset identifier (e.g. ISIN) to a data provider and the data types that provider supplies for matching assets.

Body Params
string
required

Identifier type (e.g. ISIN, CAIP19)

string
required

Identifier value (e.g. US0378331005) or "*" for all

string
required

Name of the data provider

string
enum
required

Data type this provider supplies for matching assets

Allowed:
string

Refresh interval in duration format (e.g. '1h', '24h') or 'RT' for real-time (subscription-based). Null means system default (24h).

boolean
Defaults to true

Whether this rule is active

Headers
string

32 bytes buffer (24 randomly generated bytes by the client + 8 bytes epoch timestamp seconds) encoded to hex:

const nonce = Buffer.alloc(32); nonce.fill(crypto.randomBytes(24), 0, 24);

const nowEpochSeconds = Math.floor(new Date().getTime() / 1000); const t = BigInt(nowEpochSeconds); nonce.writeBigInt64BE(t, 24);

Responses

Updated 12 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 days ago