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. For providerType 'adapter' this is the bound adapter
name; for providerType 'finp2p' this is the peer organization id serving the data.

string
enum
required

Type of the data provider. 'adapter' references a provider bound via the data
provider binding API. 'finp2p' references a peer organization on the FinP2P
network acting as a data provider; auto-created from discovery if it does not exist.

Allowed:
string
required

Data type this provider supplies for matching assets

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

acl
array of strings

Serving allow-list for a 'finp2p' rule: organization ids permitted to receive this
data over the FinP2P DataService. Empty or omitted means no peer is served
(deny-by-default). Only valid for providerType 'finp2p'; rejected for 'adapter'.

acl
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 4 months 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 4 months ago