DFS Securities Services API (latest)

Download OpenAPI specification:Download

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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

delete/v1.0/focuses/{focusId}/hierarchy

https://example-host/v1.0/focuses/{focusId}/hierarchy

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/focuses/{focusId}

https://example-host/v1.0/focuses/{focusId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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 <int32> Nullable
name	string Nullable
externalId	string Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

patch/v1.0/focuses/{focusId}

https://example-host/v1.0/focuses/{focusId}

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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 <int32> Nullable
name	string Nullable
externalId	string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/focuses

https://example-host/v1.0/focuses

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"focusId": 0,
"uId": "string"
}

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 Nullable
sortOrder	string (SortOrder) Enum: "Ascending" "Descending"
parentIds	Array of integers <int32> Nullable
name	string Nullable
search	string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/focuses/search

https://example-host/v1.0/focuses/search

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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

202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

delete/v1.0/securities/{securityId}

https://example-host/v1.0/securities/{securityId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"longRunningRequestId": "string"
}

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 Nullable
isActive required	boolean
story	string Nullable
isin	string Nullable
externalId	string Nullable
typeId required	integer <int32>
assetClassId required	integer <int32>
sectorId	integer <int32> Nullable
focusId	integer <int32> Nullable
riskCategoryId	integer <int32> Nullable
countryId	integer <int32> Nullable
currencyId required	integer <int32>
homeStockExchangeId	integer <int32> Nullable
factor required	number <double>
faceValue	number <double> Nullable
underlyingId	integer <int32> Nullable
priceEarnings	number <double> Nullable
totalExpenseRatio	number <double> Nullable
projectedExpectedReturn	number <double> Nullable
risk	number <double> Nullable
isInvestable required	boolean
isPricePercentage required	boolean
tradingUnit required	number <double>
roundingLot required	number <double>
kiid	string Nullable The Kiid URL for the security
factsheet	string Nullable The fact-sheet URL for the security
logoUrl	string Nullable
customAttributes	string Nullable
isShariahCompliant required	boolean
fundExtension	object (FundExtension)
bondExtension	object (BondExtension)
futureExtension	object (FutureExtension)
optionExtension	object (OptionExtension)

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v1.0/securities/{securityId}

https://example-host/v1.0/securities/{securityId}

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": "New Security VQ1",
"isActive": true,
"isin": "VQ1",
"externalId": "ExtId-VQ1",
"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

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/securities/{securityId}/components

https://example-host/v1.0/securities/{securityId}/components

Response samples

Content type

application/json

Copy

Expand all Collapse all


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

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

components

Array of objects (Api.Instruments.UpdateSecurityComponents.ComponentAllocation) Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v1.0/securities/{securityId}/components

https://example-host/v1.0/securities/{securityId}/components

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"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

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/securities/{securityId}/fund-breakdown

https://example-host/v1.0/securities/{securityId}/fund-breakdown

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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

categoriesBreakdowns

Array of objects (SecurityFundCategoryBreakdowns) Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v1.0/securities/{securityId}/fund-breakdown

https://example-host/v1.0/securities/{securityId}/fund-breakdown

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"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

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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 allocations cannot be returned.

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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/securities/{securityId}/allocations

https://example-host/v1.0/securities/{securityId}/allocations

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

get/v1.0/securities/{securityId}/kpi/calculate

https://example-host/v1.0/securities/{securityId}/kpi/calculate

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"risk": 0,
"return": 0,
"sharpeRatio": 0,
"downsideVolatility": 0,
"sortinoRatio": 0,
"ytdReturn": 0,
"qtdReturn": 0,
"currency": 
{"id": 0,
"uId": "string",
"currencyCode": "string",
"symbol": "string"
},
"returns": 
[
{"timeUnit": "Day",
"numberOfUnits": 0,
"return": 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 <int32> Nullable
fromDate	string <date-time> Nullable
toDate	string <date-time> Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.1/securities/{securityId}/pricehistory

https://example-host/v1.1/securities/{securityId}/pricehistory

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"stockExchangeId": 0,
"fromDate": "2024-04-10T13:50:48Z",
"toDate": "2024-04-10T13:50:48Z"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"stockExchangeId": 0,
"historicalData": 
[
{"date": "2024-04-10T13:50:48Z",
"price": 0,
"open": 0,
"high": 0,
"low": 0
}
],
"currency": 
{"id": 0,
"uId": "string",
"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 <int32> Nullable
currencyId	integer <int32> Nullable
fromDate	string <date-time> Nullable
toDate	string <date-time> Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/securities/{securityId}/performancehistory

https://example-host/v1.0/securities/{securityId}/performancehistory

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"stockExchangeId": 0,
"currencyId": 0,
"fromDate": "2024-04-10T13:50:48Z",
"toDate": "2024-04-10T13:50:48Z"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"stockExchangeId": 0,
"historicalData": 
[
{"date": "2024-04-10T13:50:48Z",
"perf": 0,
"cumPerf": 0
}
],
"currency": 
{"id": 0,
"uId": "string",
"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

securityPriceRequests required	Array of objects (SecurityPriceFilter)
priceDate	string <date-time> Nullable
currencyCode	string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.2/securities/prices

https://example-host/v1.2/securities/prices

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"securityPriceRequests": 
[
{"externalId": "string",
"marketCode": "string",
"isin": "string"
}
],
"priceDate": "2024-04-10T13:50:48Z",
"currencyCode": "string"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"securityPrices": 
[
{"isin": "string",
"externalId": "string",
"currencyCode": "string",
"valuationDate": "2024-04-10T13:50:48Z",
"marketCode": "string",
"basePrice": 0,
"price": 0,
"validityDate": "2024-04-10T13:50:48Z",
"isPricePercentage": true,
"calculationPrice": 0
}
]
}

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 Nullable
isActive required	boolean
story	string Nullable
isin	string Nullable
externalId	string Nullable
typeId required	integer <int32>
assetClassId required	integer <int32>
sectorId	integer <int32> Nullable
focusId	integer <int32> Nullable
riskCategoryId	integer <int32> Nullable
countryId	integer <int32> Nullable
currencyId required	integer <int32>
homeStockExchangeId	integer <int32> Nullable
factor required	number <double>
faceValue	number <double> Nullable
underlyingId	integer <int32> Nullable
priceEarnings	number <double> Nullable
totalExpenseRatio	number <double> Nullable
projectedExpectedReturn	number <double> Nullable
risk	number <double> Nullable
isInvestable required	boolean
isPricePercentage required	boolean
tradingUnit required	number <double>
roundingLot required	number <double>
kiid	string Nullable
factsheet	string Nullable
logoUrl	string Nullable
customAttributes	string Nullable
isShariahCompliant required	boolean
fundExtension	object (Api.Instruments.CreateSecurity.FundExtension)
bondExtension	object (Api.Instruments.CreateSecurity.BondExtension)
futureExtension	object (Api.Instruments.CreateSecurity.FutureExtension)
optionExtension	object (Api.Instruments.CreateSecurity.OptionExtension)

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.1/securities

https://example-host/v1.1/securities

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"name": "New Security NF8",
"isActive": true,
"isin": "NF8",
"externalId": "ExtId-NF8",
"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

Copy

Expand all Collapse all


{"id": 0,
"uId": "string"
}

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

esgComponents

Array of objects (ComponentScore) Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v1.0/securities/{securityId}/esgcomponents

https://example-host/v1.0/securities/{securityId}/esgcomponents

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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

fees	Array of objects (Fee) Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v1.0/securities/{securityId}/fees

https://example-host/v1.0/securities/{securityId}/fees

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"fees": 
[
{"id": 0,
"isPercentage": true,
"validFrom": "2024-04-10T13:50:48Z",
"validTo": "2024-04-10T13:50:48Z",
"feeTypeId": 0,
"feeRecurrenceTypeKey": "Single",
"feeDefinitions": 
[
{"id": 0,
"feeId": 0,
"valueFrom": 0,
"valueTo": 0,
"feeValue": 0,
"inducementValue": 0
}
]
}
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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

ratings

Array of objects (SecurityRating) Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v1.0/securities/{securityId}/ratings

https://example-host/v1.0/securities/{securityId}/ratings

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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

stockExchanges

Array of objects (SecurityStockExchange) Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

put/v1.0/securities/{securityId}/stockexchanges

https://example-host/v1.0/securities/{securityId}/stockexchanges

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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

securityThresholds

Array of objects (SecurityThreshold) Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

patch/v1.0/products/{productId}/security-order-thresholds

https://example-host/v1.0/products/{productId}/security-order-thresholds

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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

securityThresholds

Array of objects (SecurityThreshold) Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/products/{productId}/security-order-thresholds

https://example-host/v1.0/products/{productId}/security-order-thresholds

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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

thresholdsToRemove

Array of objects (SecurityOrderType) Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/products/{productId}/security-order-thresholds/remove

https://example-host/v1.0/products/{productId}/security-order-thresholds/remove

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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 <int32> Nullable
orderTypeId	string (OrderTypeKey) Enum: "Buy" "Sell"
orderThresholdTypeIds	Array of strings (OrderThresholdTypeKey) Nullable Items Enum: "SharesAmount" "MoneyFixedAmount" "RelativePortfolioAmount" "RelativePortfolioPositionAmount"

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/products/{productId}/security-order-thresholds/search

https://example-host/v1.0/products/{productId}/security-order-thresholds/search

Request samples

Payload

Content type

Copy

Expand all Collapse all


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

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"results": 
[
{"securityId": 0,
"orderType": 
{"key": "Buy",
"name": "string",
"id": 0
},
"orderThresholdType": 
{"key": "SharesAmount",
"name": "string",
"id": 0
},
"orderThresholdValue": 0
}
],
"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

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

delete/v1.0/stockexchanges/{stockExchangeId}

https://example-host/v1.0/stockexchanges/{stockExchangeId}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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 Nullable
marketCode required	string non-empty
operatingMIC	string Nullable
description	Array of objects (LocalizedValue) Nullable The description of the stock exchange.
countryId	integer <int32> Nullable

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

patch/v1.1/stockexchanges/{stockExchangeId}

https://example-host/v1.1/stockexchanges/{stockExchangeId}

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"marketCode": "QXN",
"operatingMIC": "10TA",
"description": 
[
{"languageCode": "en",
"value": "Stock Exchanged En"
}
],
"countryId": 42,
"updateProperties": 
["CountryId",
"Description",
"OperatingMIC"
]
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"code": "General",
"subCode": "string",
"message": "string",
"correlationId": "string",
"properties": 
{"property1": null,
"property2": null
}
}

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 Nullable
description	Array of objects (LocalizedValue) Nullable The description of the stock exchange.
countryId	integer <int32> Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.0/stockexchanges

https://example-host/v1.0/stockexchanges

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"marketCode": "N@B",
"operatingMIC": "R3ZO",
"description": 
[
{"languageCode": "en",
"value": "Stock Exchanged En"
}
],
"countryId": 42
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"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 Nullable
sortOrder	string (SortOrder) Enum: "Ascending" "Descending"
marketCode	string Nullable
operatingMIC	string Nullable
name	string Nullable
country	Array of integers <int32> Nullable
ids	Array of integers <int32> Nullable
search	string Nullable

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

post/v1.1/stockexchanges/search

https://example-host/v1.1/stockexchanges/search

Request samples

Payload

Content type

Copy

Expand all Collapse all


{"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

Copy

Expand all Collapse all


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

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/json

Responses

Request samples

Response samples

Create focus zone

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Search focus

Authorizations:

header Parameters

Request Body schema: application/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/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/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/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

Request Body schema:
application/json

Request Body schema:
application/json