Skip to content

Enable Copy Factory API for trading account

About

Enables Copy Factory API for trading account. The account will be temporary stopped to perform this action. Note that this is a paid option

POST /users/current/accounts/:accountId/enable-copy-factory-api

For more information see swagger documentation

Headers

Name Type Required Description
auth-token string Yes Authorization token. See Authentication and authorization

Path parameters

Name Type Required Description
accountId string Yes Trading account id

Body

Name Type Required Description
copyFactoryRoles Array<string> Yes Account roles for CopyFactory2 application. Allowed values are PROVIDER and SUBSCRIBER
copyFactoryResourceSlots number Yes Number of CopyFactory 2 resource slots to allocate to account. Allocating extra resource slots results in lower trade copying latency. Please note that allocating extra resource slots is a paid option. Please also note that CopyFactory 2 uses redundant infrastructure so that each CopyFactory resource slot is billed as 2 standard resource slots. You will be billed for CopyFactory 2 resource slots only if you have added your account to CopyFactory 2 by specifying copyFactoryRoles field.

Response

  • 204 - Copy factory API enabled for account
  • 404 - Account not found. Response schema: Error

Examples

Example request:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'auth-token: token' -d '{
    "copyFactoryRoles": [
      "PROVIDER"
    ],
    "copyFactoryResourceSlots": 1
}' 'https://mt-provisioning-api-v1.agiliumtrade.agiliumtrade.ai/users/current/accounts/1eda642a-a9a3-457c-99af-3bc5e8d5c4c9/enable-copy-factory-api'