DFS Securities Services API (latest)

Download OpenAPI specification:

Contains functionality around financial securities.

For endpoints that support localization the language can be passed either as a query string parameter (using the name 'language') or in the 'accept-language' header.
If no language is passed to such endpoints then the default configured language will be used.

Focus

Delete focus zone

Deletes a focus zone. If it is a parent focus zone it will also delete its children

Authorizations:

Bearer

path Parameters

focusId

required

integer <int32>

Focus id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get focus details

Gets focus details by Id

Authorizations:

Bearer

path Parameters

focusId

required

integer <int32>

Focus id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type

application/json

{"id": 1,
"name": "World",
"parentId": 0,
"externalId": "448586",
"uId": "f98d87e5-fca2-42d6-b31e-2aa780ab184b",
"childrenIds": [2,
3,
4,
6
]
}

Update focus zone

Updates a focus zone

Authorizations:

Bearer

path Parameters

focusId

required

integer <int32>

Focus id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Update focus request

parentId	integer or null <int32>
name	string or null
externalId	string or null

Responses

Request samples

Payload

Content type

application/json

{"parentId": 1,
"name": "World2",
"externalId": "42333"
}

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Create focus zone

Creates focus zone

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Create focus request

parentId	integer or null <int32>
name	string or null
externalId	string or null

Responses

Request samples

Payload

Content type

application/json

{"parentId": 0,
"name": "string",
"externalId": "string"
}

Response samples

Content type

application/json

{"focusId": 0,
"uId": "06ae8f12-a4f1-4b08-8dba-bea9629029f0"
}

Search focus

Searches focus configured in the application with filtering and sorting

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Search data

page	integer <int32>
pageSize	integer <int32>
sortBy	string or null
sortOrder	string (SortOrder) Enum: "Ascending" "Descending"
parentIds	Array of integers or null <int32> [ items <int32 > ]
name	string or null
search	string or null

Responses

Request samples

Payload

Content type

application/json

{"page": 0,
"pageSize": 0,
"sortBy": "string",
"sortOrder": "Ascending",
"parentIds": [0
],
"name": "string",
"search": "string"
}

Response samples

Content type

application/json

{"results": [{"id": 0,
"name": "string",
"parentId": 0,
"externalId": "string",
"uId": "string",
"childrenIds": [0
]
}
],
"page": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0
}

Instruments

Delete security

Deletes a security.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

The Id of the security to delete

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type

application/json

{"longRunningRequestId": "55cead9f-0c0c-4151-97a5-4b9bddf15493"
}

Update security

Updates a security.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

The Id of the security to update

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Properties of the security to update

name required	string non-empty
issuer	string or null
isActive required	boolean
story	string or null
isin	string or null
externalId	string or null
typeId required	integer <int32>
assetClassId required	integer <int32>
sectorId	integer or null <int32>
focusId	integer or null <int32>
riskCategoryId	integer or null <int32>
countryId	integer or null <int32>
currencyId required	integer <int32>
homeStockExchangeId	integer or null <int32>
factor required	number <double>
faceValue	number or null <double>
underlyingId	integer or null <int32>
priceEarnings	number or null <double>
totalExpenseRatio	number or null <double>
projectedExpectedReturn	number or null <double>
risk	number or null <double>
isInvestable required	boolean
isPricePercentage required	boolean
tradingUnit required	number <double>
roundingLot required	number <double>
kiid	string or null The Kiid URL for the security
factsheet	string or null The fact-sheet URL for the security
logoUrl	string or null
customAttributes	string or null
isShariahCompliant required	boolean
	object (FundExtension)
	object (BondExtension)
	object (FutureExtension)
	object (OptionExtension)

Responses

Request samples

Payload

Content type

application/json

{"name": "New Security .AN",
"isActive": true,
"isin": ".AN",
"externalId": "ExtId-.AN",
"typeId": 3,
"assetClassId": 3,
"sectorId": 1,
"focusId": 2,
"riskCategoryId": 3,
"countryId": 2,
"currencyId": 1,
"homeStockExchangeId": 1,
"factor": 0.1,
"faceValue": 1,
"underlyingId": 55,
"priceEarnings": 1.1,
"totalExpenseRatio": 1.2,
"projectedExpectedReturn": 1.05,
"risk": 0.2,
"isInvestable": true,
"isPricePercentage": true,
"tradingUnit": 1,
"roundingLot": 1,
"isShariahCompliant": true
}

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get security components

Gets a security by ID and returns its' components.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

Security id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type

application/json

{"components": [{"id": 0,
"allocation": 0.1
}
]
}

Update security components

Gets a security by ID and updates its' components.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

Security id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

request object

Array of objects or null (Api.Instruments.UpdateSecurityComponents.ComponentAllocation)

Responses

Request samples

Payload

Content type

application/json

{"components": [{"id": 5,
"allocation": 0.15
},
{"id": 7,
"allocation": 0.25
},
{"id": 9,
"allocation": 0.1
},
{"id": 11,
"allocation": 0.2
},
{"id": 12,
"allocation": 0.1
},
{"id": 21,
"allocation": 0.05
},
{"id": 23,
"allocation": 0.05
},
{"id": 150,
"allocation": 0.1
}
]
}

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get security breakdown

Gets a security by ID and returns its' breakdown. Note this is available only for securities of type Fund.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

Security Id

query Parameters

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type

application/json

{"categoriesBreakdowns": [{"category": "AssetClass",
"breakdowns": [{"id": 1,
"allocation": 0.25
},
{"id": 11,
"allocation": 0.25
},
{"id": 15,
"allocation": 0.35
},
{"id": 39,
"allocation": 0.15
}
]
},
{"category": "Country",
"breakdowns": [{"id": 4,
"allocation": 0.1
},
{"id": 13,
"allocation": 0.4
},
{"id": 23,
"allocation": 0.5
}
]
},
{"category": "Currency",
"breakdowns": [{"id": 1,
"allocation": 0.4
},
{"id": 2,
"allocation": 0.6
}
]
},
{"category": "EconomicalZone",
"breakdowns": [{"id": 1,
"allocation": 1
}
]
},
{"category": "Focus",
"breakdowns": [{"id": 2,
"allocation": 0.34
},
{"id": 5,
"allocation": 0.33
},
{"id": 6,
"allocation": 0.33
}
]
},
{"category": "Sector",
"breakdowns": [{"id": 9,
"allocation": 0.28
},
{"id": 27,
"allocation": 0.53
},
{"id": 44,
"allocation": 0.19
}
]
},
{"category": "Type",
"breakdowns": [{"id": 3,
"allocation": 0.21
},
{"id": 5,
"allocation": 0.19
},
{"id": 7,
"allocation": 0.01
},
{"id": 8,
"allocation": 0.09
},
{"id": 9,
"allocation": 0.5
}
]
}
]
}

Update security breakdown

Gets a security by ID and updates its' breakdown. Note this is available only for securities of type Fund.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

Security Id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Request object

Array of objects or null (SecurityFundCategoryBreakdowns)

Responses

Request samples

Payload

Content type

application/json

{"categoriesBreakdowns": [{"category": "AssetClass",
"breakdowns": [{"id": 1,
"allocation": 0.25
},
{"id": 11,
"allocation": 0.25
},
{"id": 15,
"allocation": 0.35
},
{"id": 39,
"allocation": 0.15
}
]
},
{"category": "Country",
"breakdowns": [{"id": 4,
"allocation": 0.1
},
{"id": 13,
"allocation": 0.4
},
{"id": 23,
"allocation": 0.5
}
]
},
{"category": "Currency",
"breakdowns": [{"id": 1,
"allocation": 0.4
},
{"id": 2,
"allocation": 0.6
}
]
},
{"category": "EconomicalZone",
"breakdowns": [{"id": 1,
"allocation": 1
}
]
},
{"category": "Focus",
"breakdowns": [{"id": 2,
"allocation": 0.34
},
{"id": 5,
"allocation": 0.33
},
{"id": 6,
"allocation": 0.33
}
]
},
{"category": "Sector",
"breakdowns": [{"id": 9,
"allocation": 0.28
},
{"id": 27,
"allocation": 0.53
},
{"id": 44,
"allocation": 0.19
}
]
},
{"category": "Type",
"breakdowns": [{"id": 3,
"allocation": 0.21
},
{"id": 5,
"allocation": 0.19
},
{"id": 7,
"allocation": 0.01
},
{"id": 8,
"allocation": 0.09
},
{"id": 9,
"allocation": 0.5
}
]
}
]
}

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get security allocations Deprecated

Gets a security by ID and returns its' allocations based on the existing breakdowns / components.

Note that components take precedence over breakdowns (i.e. if the security has both components and breakdowns, components take precedence when returning the allocations).

If the security has neither components nor breakdowns, the allocations cannot be returned. This API is deprecated. Use GET v2.0/securities/{securityId}/allocations instead.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

Security Id

query Parameters

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type

application/json

{"categoriesBreakdowns": [{"category": "AssetClass",
"breakdowns": [{"id": 1,
"allocation": 0.25
},
{"id": 11,
"allocation": 0.25
},
{"id": 15,
"allocation": 0.35
},
{"id": 39,
"allocation": 0.15
}
]
},
{"category": "Country",
"breakdowns": [{"id": 4,
"allocation": 0.1
},
{"id": 13,
"allocation": 0.4
},
{"id": 23,
"allocation": 0.5
}
]
},
{"category": "Currency",
"breakdowns": [{"id": 1,
"allocation": 0.4
},
{"id": 2,
"allocation": 0.6
}
]
},
{"category": "EconomicalZone",
"breakdowns": [{"id": 1,
"allocation": 1
}
]
},
{"category": "Focus",
"breakdowns": [{"id": 2,
"allocation": 0.34
},
{"id": 5,
"allocation": 0.33
},
{"id": 6,
"allocation": 0.33
}
]
},
{"category": "Sector",
"breakdowns": [{"id": 9,
"allocation": 0.28
},
{"id": 27,
"allocation": 0.53
},
{"id": 44,
"allocation": 0.19
}
]
},
{"category": "Type",
"breakdowns": [{"id": 3,
"allocation": 0.21
},
{"id": 5,
"allocation": 0.19
},
{"id": 7,
"allocation": 0.01
},
{"id": 8,
"allocation": 0.09
},
{"id": 9,
"allocation": 0.5
}
]
},
{"category": "ParentAssetClass",
"breakdowns": [{"id": 1,
"allocation": 0.21
},
{"id": 3,
"allocation": 0.19
},
{"id": 11,
"allocation": 0.01
},
{"id": 37,
"allocation": 0.59
}
]
},
{"category": "ParentSector",
"breakdowns": [{"id": 79,
"allocation": 0.21
},
{"id": 12,
"allocation": 0.19
},
{"id": 225,
"allocation": 0.01
},
{"id": 172,
"allocation": 0.09
},
{"id": 200,
"allocation": 0.5
}
]
}
]
}

Get security allocations

Gets a security by ID and returns its' allocations based on the existing breakdowns / components.

Note that components take precedence over breakdowns (i.e. if the security has both components and breakdowns, components take precedence when returning the allocations).

If the security has neither components nor breakdowns, the returned allocations will be an empty collection.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

Security Id

query Parameters

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type

application/json

{"categoriesBreakdowns": [{"category": "AssetClass",
"breakdowns": [{"id": 1,
"allocation": 0.25
},
{"id": 11,
"allocation": 0.25
},
{"id": 15,
"allocation": 0.35
},
{"id": 39,
"allocation": 0.15
}
]
},
{"category": "Country",
"breakdowns": [{"id": 4,
"allocation": 0.1
},
{"id": 13,
"allocation": 0.4
},
{"id": 23,
"allocation": 0.5
}
]
},
{"category": "Currency",
"breakdowns": [{"id": 1,
"allocation": 0.4
},
{"id": 2,
"allocation": 0.6
}
]
},
{"category": "EconomicalZone",
"breakdowns": [{"id": 1,
"allocation": 1
}
]
},
{"category": "Focus",
"breakdowns": [{"id": 2,
"allocation": 0.34
},
{"id": 5,
"allocation": 0.33
},
{"id": 6,
"allocation": 0.33
}
]
},
{"category": "Sector",
"breakdowns": [{"id": 9,
"allocation": 0.28
},
{"id": 27,
"allocation": 0.53
},
{"id": 44,
"allocation": 0.19
}
]
},
{"category": "Type",
"breakdowns": [{"id": 3,
"allocation": 0.21
},
{"id": 5,
"allocation": 0.19
},
{"id": 7,
"allocation": 0.01
},
{"id": 8,
"allocation": 0.09
},
{"id": 9,
"allocation": 0.5
}
]
},
{"category": "ParentAssetClass",
"breakdowns": [{"id": 1,
"allocation": 0.21
},
{"id": 3,
"allocation": 0.19
},
{"id": 11,
"allocation": 0.01
},
{"id": 37,
"allocation": 0.59
}
]
},
{"category": "ParentSector",
"breakdowns": [{"id": 79,
"allocation": 0.21
},
{"id": 12,
"allocation": 0.19
},
{"id": 225,
"allocation": 0.01
},
{"id": 172,
"allocation": 0.09
},
{"id": 200,
"allocation": 0.5
}
]
}
]
}

Get security KPIs

Gets a security by ID and returns its KPIs.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

Security Id

query Parameters

currencyId

integer <int32>

Currency Id (optional - if not specified, the security currency is used)

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type

application/json

{"risk": 0.1,
"return": 0.1,
"sharpeRatio": 0.1,
"downsideVolatility": 0.1,
"sortinoRatio": 0.1,
"ytdReturn": 0.1,
"qtdReturn": 0.1,
"currency": {"id": 0,
"uId": "06ae8f12-a4f1-4b08-8dba-bea9629029f0",
"currencyCode": "string",
"symbol": "string"
},
"returns": [{"timeUnit": "Day",
"numberOfUnits": 0,
"return": 0.1
}
],
"calculationKpis": {"fromDate": "string",
"toDate": "string",
"dataPoints": 0
}
}

Get security historical prices

Gets a security by ID. Returns the historical prices of the security.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

Security id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

request object

stockExchangeId	integer or null <int32>
fromDate	string or null <date-time>
toDate	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

{"stockExchangeId": 0,
"fromDate": "2019-08-24T14:15:22Z",
"toDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"stockExchangeId": 0,
"historicalData": [{"date": "2019-08-24T14:15:22Z",
"price": 0.1,
"open": 0.1,
"high": 0.1,
"low": 0.1
}
],
"currency": {"id": 0,
"uId": "06ae8f12-a4f1-4b08-8dba-bea9629029f0",
"currencyCode": "string",
"symbol": "string"
}
}

Get security historical performances

Gets a security by ID. Returns the historical performances of the security.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

Security id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

request object

stockExchangeId	integer or null <int32>
currencyId	integer or null <int32>
fromDate	string or null <date-time>
toDate	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

{"stockExchangeId": 0,
"currencyId": 0,
"fromDate": "2019-08-24T14:15:22Z",
"toDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"stockExchangeId": 0,
"historicalData": [{"date": "2019-08-24T14:15:22Z",
"perf": 0.1,
"cumPerf": 0.1
}
],
"currency": {"id": 0,
"uId": "06ae8f12-a4f1-4b08-8dba-bea9629029f0",
"currencyCode": "string",
"symbol": "string"
}
}

Get security prices

Retrieves the latest security prices for the securities and currencies specified in the parameters. Automatically tries to convert prices to the desired currency if they are not available in the requested currency.

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

The parameter DTO

required	Array of objects (SecurityPriceFilter)
priceDate	string or null <date-time>
currencyCode	string or null

Responses

Request samples

Payload

Content type

application/json

{"securityPriceRequests": [{"externalId": "string",
"marketCode": "string",
"isin": "string"
}
],
"priceDate": "2019-08-24T14:15:22Z",
"currencyCode": "string"
}

Response samples

Content type

application/json

{"securityPrices": [{"isin": "string",
"externalId": "string",
"currencyCode": "string",
"valuationDate": "2019-08-24T14:15:22Z",
"marketCode": "string",
"basePrice": 0.1,
"price": 0.1,
"validityDate": "2019-08-24T14:15:22Z",
"isPricePercentage": true,
"calculationPrice": 0.1
}
]
}

Create security

Creates a new security.

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Properties of the security to create

name required	string non-empty
issuer	string or null
isActive required	boolean
story	string or null
isin	string or null
externalId	string or null
typeId required	integer <int32>
assetClassId required	integer <int32>
sectorId	integer or null <int32>
focusId	integer or null <int32>
riskCategoryId	integer or null <int32>
countryId	integer or null <int32>
currencyId required	integer <int32>
homeStockExchangeId	integer or null <int32>
factor required	number <double>
faceValue	number or null <double>
underlyingId	integer or null <int32>
priceEarnings	number or null <double>
totalExpenseRatio	number or null <double>
projectedExpectedReturn	number or null <double>
risk	number or null <double>
isInvestable required	boolean
isPricePercentage required	boolean
tradingUnit required	number <double>
roundingLot required	number <double>
kiid	string or null
factsheet	string or null
logoUrl	string or null
customAttributes	string or null
isShariahCompliant required	boolean
	object (Api.Instruments.CreateSecurity.FundExtension)
	object (Api.Instruments.CreateSecurity.BondExtension)
	object (Api.Instruments.CreateSecurity.FutureExtension)
	object (Api.Instruments.CreateSecurity.OptionExtension)

Responses

Request samples

Payload

Content type

application/json

{"name": "New Security LDO",
"isActive": true,
"isin": "LDO",
"externalId": "ExtId-LDO",
"typeId": 3,
"assetClassId": 3,
"sectorId": 1,
"focusId": 2,
"riskCategoryId": 3,
"countryId": 2,
"currencyId": 1,
"homeStockExchangeId": 1,
"factor": 0.1,
"faceValue": 1,
"underlyingId": 55,
"priceEarnings": 1.1,
"totalExpenseRatio": 1.2,
"projectedExpectedReturn": 1.05,
"risk": 0.2,
"isInvestable": true,
"isPricePercentage": true,
"tradingUnit": 1,
"roundingLot": 1,
"isShariahCompliant": true
}

Response samples

Content type

application/json

{"id": 0,
"uId": "06ae8f12-a4f1-4b08-8dba-bea9629029f0"
}

Export security historical prices

Exports to CSV file the historical prices of a security.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

stockExchangeId	integer or null <int32>
fromDate	string or null <date-time>
toDate	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

{"stockExchangeId": 0,
"fromDate": "2019-08-24T14:15:22Z",
"toDate": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Import security historical prices.

Imports a CSV file containing the historical prices of a security.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

Security Id

header Parameters

recalculatePerformances	boolean If True the endpoint will recalculate Performances for the security.
Accept-Language	string The ISO 639-1 language to use for localizable data.

Request Body schema: multipart/form-data

file	string <binary> The csv file containing the historical prices of a security.

Responses

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Update security ESG components

Gets a security by ID and updates its' ESG components.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

Security id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

request object

Array of objects or null (ComponentScore)

Responses

Request samples

Payload

Content type

application/json

{"esgComponents": [{"id": 0,
"score": 0.1
}
]
}

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Update security fees

Gets a security by ID and updates its' fees.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

Security Id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Request object

Array of objects or null (Fee)

Responses

Request samples

Payload

Content type

application/json

{"fees": [{"id": 0,
"isPercentage": true,
"validFrom": "2019-08-24T14:15:22Z",
"validTo": "2019-08-24T14:15:22Z",
"feeTypeId": 0,
"feeRecurrenceTypeKey": "Single",
"feeDefinitions": [{"id": 0,
"feeId": 0,
"valueFrom": 0.1,
"valueTo": 0.1,
"feeValue": 0.1,
"inducementValue": 0.1
}
]
}
]
}

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Update security ratings

Gets a security by ID and updates its' ratings.

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

Security Id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Request object

Array of objects or null (SecurityRating)

Responses

Request samples

Payload

Content type

application/json

{"ratings": [{"ratingAgencyId": 0,
"ratingId": 0
}
]
}

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Update security stock exchanges

Gets a security by ID and updates its' stock exchanges. Mandatory Fields:

StockExchangeId
CurrencyId
IsDefault

Authorizations:

Bearer

path Parameters

securityId

required

integer <int32>

Security Id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Request object

Array of objects or null (SecurityStockExchange)

Responses

Request samples

Payload

Content type

application/json

{"stockExchanges": [{"stockExchangeId": 0,
"ticker": "string",
"securityStockExchangeId": "string",
"currencyId": 0,
"priceFeedIntegrationIdentifierType": "string",
"priceFeedIntegrationIdentifier": "string",
"isDefault": true
}
]
}

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

SecurityOrderThreshold

Modify order thresholds of securities

Modifies order thresholds associated with securities of a product.

Authorizations:

Bearer

path Parameters

productId

required

integer <int32>

Product id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Array of objects or null (SecurityThreshold)

Responses

Request samples

Payload

Content type

application/json

{"securityThresholds": [{"securityId": 0,
"orderTypeId": "Buy",
"orderThresholdTypeId": "SharesAmount",
"orderThresholdValue": 0.1
}
]
}

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Create order thresholds of securities

Creates order thresholds associated with securities of a product.

Authorizations:

Bearer

path Parameters

productId

required

integer <int32>

Product id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Array of objects or null (SecurityThreshold)

Responses

Request samples

Payload

Content type

application/json

{"securityThresholds": [{"securityId": 0,
"orderTypeId": "Buy",
"orderThresholdTypeId": "SharesAmount",
"orderThresholdValue": 0.1
}
]
}

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Remove order thresholds of securities

Removes order thresholds associated with securities of a product.

Authorizations:

Bearer

path Parameters

productId

required

integer <int32>

Product id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

request object

Array of objects or null (SecurityOrderType)

Responses

Request samples

Payload

Content type

application/json

{"thresholdsToRemove": [{"securityId": 0,
"orderTypeId": "Buy"
}
]
}

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Search for order thresholds of securities

Searches for order thresholds associated with securities of a product.

Authorizations:

Bearer

path Parameters

productId

required

integer <int32>

Product id

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

request object

page	integer <int32>
pageSize	integer <int32>
securityIds	Array of integers or null <int32> [ items <int32 > ]
orderTypeId	string (OrderTypeKey) Enum: "Buy" "Sell"
orderThresholdTypeIds	Array of strings or null (OrderThresholdTypeKey) Enum: "SharesAmount" "MoneyFixedAmount" "RelativePortfolioAmount" "RelativePortfolioPositionAmount"

Responses

Request samples

Payload

Content type

application/json

{"page": 0,
"pageSize": 0,
"securityIds": [0
],
"orderTypeId": "Buy",
"orderThresholdTypeIds": ["SharesAmount"
]
}

Response samples

Content type

application/json

{"results": [{"securityId": 0,
"orderType": {"key": "Buy",
"name": "string",
"id": 0
},
"orderThresholdType": {"key": "SharesAmount",
"name": "string",
"id": 0
},
"orderThresholdValue": 0.1
}
],
"page": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0
}

StockExchanges

Delete stock exchange

Delete an existing stock exchange

Authorizations:

Bearer

path Parameters

stockExchangeId

required

integer <int32>

The id of the stock exchange.

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Update stock exchange

Update an existing stock exchange

Authorizations:

Bearer

path Parameters

stockExchangeId

required

integer <int32>

The id of the stock exchange.

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Properties of the stock exchange to modify

updateProperties	Array of strings or null unique
marketCode required	string non-empty
operatingMIC	string or null
	Array of objects or null (LocalizedValue) The description of the stock exchange.
countryId	integer or null <int32>

Responses

Request samples

Payload

Content type

application/json

{"marketCode": "29@",
"operatingMIC": "YNAM",
"description": [{"languageCode": "en",
"value": "Stock Exchanged En"
}
],
"countryId": 42,
"updateProperties": ["CountryId",
"Description",
"OperatingMIC"
]
}

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Create stock exchange

Create a new stock exchange

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

Properties of the stock exchange to create

marketCode required	string non-empty
operatingMIC	string or null
	Array of objects or null (LocalizedValue) The description of the stock exchange.
countryId	integer or null <int32>

Responses

Request samples

Payload

Content type

application/json

{"marketCode": "KS@",
"operatingMIC": "732M",
"description": [{"languageCode": "en",
"value": "Stock Exchanged En"
}
],
"countryId": 42
}

Response samples

Content type

application/json

{"id": 0
}

Search Stock Exchanges

Search the stock exchanges configured in the application with filtering and sorting

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

page	integer <int32>
pageSize	integer <int32>
sortBy	string or null
sortOrder	string (SortOrder) Enum: "Ascending" "Descending"
marketCode	string or null
operatingMIC	string or null
name	string or null
country	Array of integers or null <int32> [ items <int32 > ]
ids	Array of integers or null <int32> [ items <int32 > ]
search	string or null

Responses

Request samples

Payload

Content type

application/json

{"page": 0,
"pageSize": 0,
"sortBy": "string",
"sortOrder": "Ascending",
"marketCode": "string",
"operatingMIC": "string",
"name": "string",
"country": [0
],
"ids": [0
],
"search": "string"
}

Response samples

Content type

application/json

{"results": [{"id": 0,
"marketCode": "string",
"operatingMIC": "string",
"description": "string",
"country": {"id": 0,
"name": "string"
}
}
],
"page": 0,
"pageSize": 0,
"pageCount": 0,
"totalCount": 0
}

Watchlists

Delete watchlist

Deletes the passed watchlist of a person.

Authorizations:

Bearer

path Parameters

watchlistId

required

integer <int32>

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Update watchlist

Updates the watchlist of a person.

Authorizations:

Bearer

path Parameters

watchlistId

required

integer <int32>

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

name	string or null
isDefault	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"isDefault": true
}

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Delete security from watchlist

Deletes the passed security from the watchlist of a person.

Authorizations:

Bearer

path Parameters

watchlistId required	integer <int32>
securityId required	integer <int32>

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Add security to watchlist

Adds the passed security to the watchlist of a person.

Authorizations:

Bearer

path Parameters

watchlistId required	integer <int32>
securityId required	integer <int32>

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get watchlists

Gets the watchlists of a person.

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

200
400
401
403
500

Content type

application/json

{"watchlists": [{"id": 0,
"name": "string",
"isDefault": true
}
]
}

Create watchlist

Creates a new watchlist.

Authorizations:

Bearer

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

name	string or null
isDefault	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"isDefault": true
}

Response samples

Content type

application/json

{"id": 0
}

Get watchlist securities

Gets the securities of a watchlist of a person.

Authorizations:

Bearer

path Parameters

watchlistId

required

integer <int32>

query Parameters

currencyId

integer <int32>

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Responses

Response samples

Content type

application/json

{"securities": [{"uId": "716ec536-78d2-4fc1-b4bc-a08044914658",
"currency": {"id": 2,
"uId": "2f87cc20-5347-43ea-a083-3122f16cbdb0",
"currencyCode": "EUR",
"symbol": "€"
},
"valuationDate": "2026-03-25T00:00:00+00:00",
"kpiLastDayPerf": 1.123,
"kpiWtdPerf": 1.123,
"kpiMtdPerf": 1.123,
"kpiQtdPerf": 1.123,
"kpiYtdPerf": 1.123,
"kpiLast3MonthsPerf": 1.123,
"kpiLast6MonthsPerf": 1.123,
"kpiLastYearPerf": 1.123,
"kpiLast3YearsPerf": 1.123,
"kpiLast5YearsPerf": 1.123
}
]
}

Update watchlist securities

Updates the securities of a watchlist of a person.

Authorizations:

Bearer

path Parameters

watchlistId

required

integer <int32>

header Parameters

Accept-Language

string

The ISO 639-1 language to use for localizable data.

Request Body schema:
application/json

ids	Array of integers or null <int32> [ items <int32 > ]

Responses

Request samples

Payload

Content type

application/json

{"ids": [1,
2,
3,
4,
5,
6,
7
]
}

Response samples

Content type

application/json

{"code": "BadRequest",
"subCode": "NA",
"message": "The request was not in the required format",
"correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

DFS Securities Services API (latest)

Focus

Delete focus zone

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Get focus details

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update focus zone

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

Create focus zone

Authorizations:

header Parameters

Request Body schema: application/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

Search focus

Authorizations:

header Parameters

Request Body schema: application/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

Instruments

Delete security

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update security

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

Get security components

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update security components

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

Get security breakdown

Authorizations:

path Parameters

query Parameters

header Parameters

Responses

Response samples

Update security breakdown

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonapplication/*+jsonapplication/json

Responses

Request samples

Response samples

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json