Loading

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:
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": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Get focus details

Gets focus details by Id

Authorizations:
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":
    [
    ]
}

Update focus zone

Updates a focus zone

Authorizations:
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:

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

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": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Create focus zone

Creates focus zone

Authorizations:
header Parameters
Accept-Language
string

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

Request Body schema:

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

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
}

Search focus

Searches focus configured in the application with filtering and sorting

Authorizations:
header Parameters
Accept-Language
string

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

Request Body schema:

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

Content type
Copy
Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "parentIds":
    [
    ],
  • "name": "string",
  • "search": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "results":
    [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

Instruments

Delete security

Deletes a security.

Authorizations:
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:
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:

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>
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 (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

Content type
Copy
Expand all Collapse all
{
  • "name": "New Security U64",
  • "isActive": true,
  • "isin": "U64",
  • "externalId": "ExtId-U64",
  • "typeId": 3,
  • "assetClassId": 3,
  • "sectorId": 1,
  • "focusId": 2,
  • "riskCategoryId": 3,
  • "countryId": 2,
  • "currencyId": 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": "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:
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":
    [
    ]
}

Update security components

Gets a security by ID and updates its' components.

Authorizations:
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:

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

Content type
Copy
Expand all Collapse all
{
  • "components":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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:
path Parameters
securityId
required
integer <int32>

Security Id

query Parameters
category
string (FundBreakdownCategory)
Enum: "AssetClass" "Country" "Currency" "EconomicalZone" "Focus" "Sector" "Type"

Breakdown category

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":
    [
    ]
}

Update security breakdown

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

Authorizations:
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:

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

Content type
Copy
Expand all Collapse all
{
  • "categoriesBreakdowns":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

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:
path Parameters
securityId
required
integer <int32>

Security Id

query Parameters
category
string (Api.Instruments.GetSecurityAllocations.FundBreakdownCategory)
Enum: "AssetClass" "Country" "Currency" "EconomicalZone" "Instrument" "Focus" "Sector" "Type" "ParentAssetClass" "ParentSector"

Breakdown category

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":
    [
    ]
}

Get security historical prices

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

Authorizations:
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:

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

Content type
Copy
Expand all Collapse all
{
  • "stockExchangeId": 0,
  • "fromDate": "2023-05-24T07:09:16Z",
  • "toDate": "2023-05-24T07:09:16Z"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "stockExchangeId": 0,
  • "historicalData":
    [
    ],
  • "currency":
    {
    }
}

Get security historical performances

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

Authorizations:
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:

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

Content type
Copy
Expand all Collapse all
{
  • "stockExchangeId": 0,
  • "currencyId": 0,
  • "fromDate": "2023-05-24T07:09:16Z",
  • "toDate": "2023-05-24T07:09:16Z"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "stockExchangeId": 0,
  • "historicalData":
    [
    ],
  • "currency":
    {
    }
}

Get security prices Deprecated

This API is deprecated. Use POST /v1.2/securities/prices instead.

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:
header Parameters
Accept-Language
string

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

Request Body schema:

The parameter DTO

securityPriceRequests
required
Array of objects (SecurityPriceFilterV11)
priceDate
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/prices
https://example-host/v1.1/securities/prices

Request samples

Content type
Copy
Expand all Collapse all
{
  • "securityPriceRequests":
    [
    ],
  • "priceDate": "2023-05-24T07:09:16Z"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "securityPrices":
    [
    ]
}

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:
header Parameters
Accept-Language
string

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

Request Body schema:

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

Content type
Copy
Expand all Collapse all
{
  • "securityPriceRequests":
    [
    ],
  • "priceDate": "2023-05-24T07:09:16Z",
  • "currencyCode": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "securityPrices":
    [
    ]
}

Create security

Creates a new security.

Authorizations:
header Parameters
Accept-Language
string

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

Request Body schema:

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

Content type
Copy
Expand all Collapse all
{
  • "name": "New Security PYM",
  • "isActive": true,
  • "isin": "PYM",
  • "externalId": "ExtId-PYM",
  • "typeId": 3,
  • "assetClassId": 3,
  • "sectorId": 1,
  • "focusId": 2,
  • "riskCategoryId": 3,
  • "countryId": 2,
  • "currencyId": 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
}

Update security ESG components

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

Authorizations:
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:

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

Content type
Copy
Expand all Collapse all
{
  • "esgComponents":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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:
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:

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

Content type
Copy
Expand all Collapse all
{
  • "fees":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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:
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:

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

Content type
Copy
Expand all Collapse all
{
  • "ratings":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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:
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:

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

Content type
Copy
Expand all Collapse all
{
  • "stockExchanges":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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:
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:
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

Content type
Copy
Expand all Collapse all
{
  • "securityThresholds":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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:
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:
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

Content type
Copy
Expand all Collapse all
{
  • "securityThresholds":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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:
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:

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

Content type
Copy
Expand all Collapse all
{
  • "thresholdsToRemove":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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:
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:

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

Content type
Copy
Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "securityIds":
    [
    ],
  • "orderTypeId": "Buy",
  • "orderThresholdTypeIds":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "results":
    [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}

StockExchanges

Delete stock exchange

Delete an existing stock exchange

Authorizations:
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": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Update stock exchange Deprecated

Update an existing stock exchange
This API is deprecated. Use PATCH /v1.1/stockexchanges/{stockExchangeId} instead.

Authorizations:
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:

Properties of the stock exchange to modify

marketCode
required
string non-empty
description
object (UpdateProperty%3C%3E)
countryId
object (Api.StockExchanges.ModifyStockExchange.UpdateProperty%3CSystem.Nullable%3CInt16%3E%3E)

Responses

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

422

UnprocessableEntity

500

Server Error

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

Request samples

Content type
Copy
Expand all Collapse all
{
  • "marketCode": "D1C",
  • "description":
    {
    },
  • "countryId":
    {
    }
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Update stock exchange

Update an existing stock exchange

Authorizations:
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:

Properties of the stock exchange to modify

updateProperties
Array of strings Nullable
marketCode
required
string non-empty
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

Content type
Copy
Expand all Collapse all
{
  • "marketCode": "9G2",
  • "description":
    [
    ],
  • "countryId": 42,
  • "updateProperties":
    [
    ]
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "code": "BadRequest",
  • "subCode": "NA",
  • "message": "The request was not in the required format",
  • "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}

Create stock exchange

Create a new stock exchange

Authorizations:
header Parameters
Accept-Language
string

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

Request Body schema:

Properties of the stock exchange to create

marketCode
required
string non-empty
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

Content type
Copy
Expand all Collapse all
{
  • "marketCode": "IPT",
  • "description":
    [
    ],
  • "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:
header Parameters
Accept-Language
string

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

Request Body schema:
page
integer <int32>
pageSize
integer <int32>
sortBy
string Nullable
sortOrder
string (SortOrder)
Enum: "Ascending" "Descending"
marketCode
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

Content type
Copy
Expand all Collapse all
{
  • "page": 0,
  • "pageSize": 0,
  • "sortBy": "string",
  • "sortOrder": "Ascending",
  • "marketCode": "string",
  • "name": "string",
  • "country":
    [
    ],
  • "ids":
    [
    ],
  • "search": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "results":
    [
    ],
  • "page": 0,
  • "pageSize": 0,
  • "pageCount": 0,
  • "totalCount": 0
}