Strategy

Get Strategies

get
/strategies

Get a list of all strategies.

Authorizations
OAuth2clientCredentialsRequired
Query parameters
cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20
Responses
200

OK

application/json
get
/strategies

Create strategy

post
/strategies

Create a strategy

Authorizations
OAuth2clientCredentialsRequired
Body

Single strategy model for creation.

namestring · max: 255Required

Name of the strategy.

codestring · max: 5Required

Code of the strategy.

descriptionstring · max: 2000Optional

Description of the strategy.

typeundefined · enumRequired

Type of the strategy.

Possible values:
automationbooleanRequired

Indicates whether a strategy is rebalanced automatically or not.

automatedInvestingbooleanOptional

Indicates whether the automated investing is applied to the strategy. Is required in case automation = true.

executionStartDatestring · dateOptional

The date when the strategy is activated. This is only required in case automation is set to true.

executionEndDatestring · dateOptional

The date when performing of the strategy is stopped. This is only required in case automation is set to true.

executionFrequencyundefined · enumOptional

Indicates how often the strategy is rebalanced automatically.

Possible values:
minOrderAmountnumber · min: 1Optional

The minimum order amount per asset of the strategy.

orderDisaggregatedbooleanOptional

Indicates whether the orders of all subscribed strategy customer products should be sent separately or aggregated to the exchange.

minInvestingAmountnumber · min: 1Optional

A cash amount to invest from a settlement account. When cash is deposited into a settlement account, and the deposited cash amount is >= minInvestingAmount, then instant rebalancing and execution are applied.

minInvestingAmountCurrencyundefined · enumOptional

Currency code in ISO 4217. Required if automatedInvesting is true.

Possible values:
Responses
200

OK

application/json
post
/strategies

Get Strategy by customer product ID

get
/products/{customerProductId}/strategies

Find which strategy is assigned to the given customer product ID.

Authorizations
OAuth2clientCredentialsRequired
Path parameters
customerProductIdstring · uuidRequired

Unique customer product identification number in UUID format

Responses
200

OK

application/json
get
/products/{customerProductId}/strategies

Get Strategy

get
/strategies/{strategyId}

Get a strategy by its ID.

Authorizations
OAuth2clientCredentialsRequired
Path parameters
strategyIdstring · uuidRequired

Strategy ID

Responses
200

OK

application/json
get
/strategies/{strategyId}

Delete strategy

delete
/strategies/{strategyId}

Delete a strategy by its ID.

Authorizations
OAuth2clientCredentialsRequired
Path parameters
strategyIdstring · uuidRequired

Strategy ID

Responses
200

OK

No content

delete
/strategies/{strategyId}

No content

Update strategy

patch
/strategies/{strategyId}

Update a strategy by its ID.

Authorizations
OAuth2clientCredentialsRequired
Path parameters
strategyIdstring · uuidRequired

Strategy ID

Body

Single strategy update model.

namestring · max: 255Optional

Name of the strategy.

codestring · max: 5Optional

Code of the strategy.

descriptionstring · max: 2000Optional

Description of the strategy.

typeundefined · enumOptional

Type of the strategy.

Possible values:
automationbooleanOptional

Indicates whether a strategy is rebalanced automatically or not.

automatedInvestingbooleanOptional

Indicates whether the automated investing is applied to the strategy. Is required in case automation = true.

executionStartDatestring · dateOptional

The date when the strategy is activated.

executionEndDatestring · dateOptional

The date when performing of the strategy is stopped.

executionFrequencyundefined · enumOptional

Indicates how often the strategy is rebalanced automatically.

Possible values:
minOrderAmountnumber · min: 1Optional

The minimum order amount per asset of the strategy.

orderDisaggregatedbooleanOptional

Indicates whether the orders of all subscribed strategy customer products should be sent separately or aggregated to the exchange.

minInvestingAmountnumber · min: 1Optional

A cash amount to invest from a settlement account. When cash is deposited into a settlement account, and the deposited cash amount is >= minInvestingAmount, then instant rebalancing and execution are applied.

minInvestingAmountCurrencyundefined · enumOptional

Currency code in ISO 4217. Required if automatedInvesting is true.

Possible values:
Responses
200

OK

No content

patch
/strategies/{strategyId}

No content

Add strategy subscriber

post
/strategies/{strategyId}/subscribers

Add a subscriber to the strategy.

Authorizations
OAuth2clientCredentialsRequired
Path parameters
strategyIdstring · uuidRequired

The UUID of the strategy.

Body

Subscribers for a given strategy.

customerIdstring · uuidRequired

ID of the customer.

Responses
200

OK

application/json
post
/strategies/{strategyId}/subscribers

Update all strategy subscribers

patch
/strategies/{strategyId}/subscribers

Replaces all strategy subscribers with the new ones.

Authorizations
OAuth2clientCredentialsRequired
Path parameters
strategyIdstring · uuidRequired

The UUID of the strategy.

Bodyobject · StrategySubscriberData[]

Subscribers for a given strategy.

customerIdstring · uuidRequired

ID of the customer.

Responses
patch
/strategies/{strategyId}/subscribers

No content

Remove all strategy subscribers

delete
/strategies/{strategyId}/subscribers

Removes all subscribers from the strategy.

Authorizations
OAuth2clientCredentialsRequired
Path parameters
strategyIdstring · uuidRequired

The UUID of the strategy.

Responses
delete
/strategies/{strategyId}/subscribers

No content

Remove strategy subscriber

delete
/strategies/{strategyId}/subscribers/{subscriberId}

Removes a subscriber from the strategy.

Authorizations
OAuth2clientCredentialsRequired
Path parameters
strategyIdstring · uuidRequired

The UUID of the strategy.

subscriberIdstring · uuidRequired

The UUID of the strategy subscriber.

Responses
delete
/strategies/{strategyId}/subscribers/{subscriberId}

No content

Update strategy subscriber

patch
/strategies/{strategyId}/subscribers/{subscriberId}

Update a subscriber in the strategy.

Authorizations
OAuth2clientCredentialsRequired
Path parameters
strategyIdstring · uuidRequired

The UUID of the strategy.

subscriberIdstring · uuidRequired

The UUID of the strategy subscriber.

Body

Subscribers for a given strategy.

customerIdstring · uuidOptional

ID of the customer.

Responses
patch
/strategies/{strategyId}/subscribers/{subscriberId}

No content

Last updated