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.
Deletes a focus zone. If it is a parent focus zone it will also delete its children
| focusId required | integer <int32> Focus id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Gets focus details by Id
| focusId required | integer <int32> Focus id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "id": 1,
- "name": "World",
- "parentId": 0,
- "externalId": "448586",
- "uId": "f98d87e5-fca2-42d6-b31e-2aa780ab184b",
- "childrenIds": [
- 2,
- 3,
- 4,
- 6
]
}Updates a focus zone
| focusId required | integer <int32> Focus id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Update focus request
| parentId | integer <int32> Nullable |
| name | string Nullable |
| externalId | string Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "parentId": 1,
- "name": "World2",
- "externalId": "42333"
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Creates focus zone
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Create focus request
| parentId | integer <int32> Nullable |
| name | string Nullable |
| externalId | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "parentId": 0,
- "name": "string",
- "externalId": "string"
}{- "focusId": 0
}Searches focus configured in the application with filtering and sorting
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
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 |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "page": 0,
- "pageSize": 0,
- "sortBy": "string",
- "sortOrder": "Ascending",
- "parentIds": [
- 0
], - "name": "string",
- "search": "string"
}{- "results": [
- {
- "id": 0,
- "name": "string",
- "parentId": 0,
- "externalId": "string",
- "uId": "string",
- "childrenIds": [
- 0
]
}
], - "page": 0,
- "pageSize": 0,
- "pageCount": 0,
- "totalCount": 0
}Deletes a security.
| securityId required | integer <int32> The Id of the security to delete |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Accepted
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "longRunningRequestId": "string"
}Updates a security.
| securityId required | integer <int32> The Id of the security to update |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
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 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) |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "name": "New Security SRW",
- "isActive": true,
- "isin": "SRW",
- "externalId": "ExtId-SRW",
- "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
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Gets a security by ID and returns its' components.
| securityId required | integer <int32> Security id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "components": [
- {
- "id": 0,
- "allocation": 0
}
]
}Gets a security by ID and updates its' components.
| securityId required | integer <int32> Security id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
request object
| components | Array of objects (Api.Instruments.UpdateSecurityComponents.ComponentAllocation) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "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
}
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Gets a security by ID and returns its' breakdown. Note this is available only for securities of type Fund.
| securityId required | integer <int32> Security Id |
| category | string (FundBreakdownCategory) Enum: "AssetClass" "Country" "Currency" "EconomicalZone" "Focus" "Sector" "Type" Breakdown category |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "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
}
]
}
]
}Gets a security by ID and updates its' breakdown. Note this is available only for securities of type Fund.
| securityId required | integer <int32> Security Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request object
| categoriesBreakdowns | Array of objects (SecurityFundCategoryBreakdowns) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "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
}
]
}
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}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.
| securityId required | integer <int32> Security Id |
| category | string (Api.Instruments.GetSecurityAllocations.FundBreakdownCategory) Enum: "AssetClass" "Country" "Currency" "EconomicalZone" "Instrument" "Focus" "Sector" "Type" "ParentAssetClass" "ParentSector" Breakdown category |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "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
}
]
}
]
}Gets a security by ID. Returns the historical prices of the security.
| securityId required | integer <int32> Security id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
request object
| stockExchangeId | integer <int32> Nullable |
| fromDate | string <date-time> Nullable |
| toDate | string <date-time> Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "stockExchangeId": 0,
- "fromDate": "2023-09-15T09:10:08Z",
- "toDate": "2023-09-15T09:10:08Z"
}{- "stockExchangeId": 0,
- "historicalData": [
- {
- "date": "2023-09-15T09:10:08Z",
- "price": 0,
- "open": 0,
- "high": 0,
- "low": 0
}
], - "currency": {
- "id": 0,
- "uId": "string",
- "currencyCode": "string",
- "symbol": "string"
}
}Gets a security by ID. Returns the historical performances of the security.
| securityId required | integer <int32> Security id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
request object
| stockExchangeId | integer <int32> Nullable |
| currencyId | integer <int32> Nullable |
| fromDate | string <date-time> Nullable |
| toDate | string <date-time> Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "stockExchangeId": 0,
- "currencyId": 0,
- "fromDate": "2023-09-15T09:10:08Z",
- "toDate": "2023-09-15T09:10:08Z"
}{- "stockExchangeId": 0,
- "historicalData": [
- {
- "date": "2023-09-15T09:10:08Z",
- "perf": 0,
- "cumPerf": 0
}
], - "currency": {
- "id": 0,
- "uId": "string",
- "currencyCode": "string",
- "symbol": "string"
}
}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.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
| securityPriceRequests required | Array of objects (SecurityPriceFilterV11) |
| priceDate | string <date-time> Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "securityPriceRequests": [
- {
- "externalId": "string",
- "currencyCode": "string",
- "marketCode": "string"
}
], - "priceDate": "2023-09-15T09:10:08Z"
}{- "securityPrices": [
- {
- "isin": "US88160R1014",
- "externalId": "US88160R1014",
- "currencyCode": "USD",
- "valuationDate": "2023-09-15T00:00:00+00:00",
- "marketCode": "NSQ",
- "price": 890,
- "validityDate": "2023-09-25T00:00:00+00:00",
- "isPricePercentage": false,
- "calculationPrice": 890
}
]
}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.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
The parameter DTO
| securityPriceRequests required | Array of objects (SecurityPriceFilter) |
| priceDate | string <date-time> Nullable |
| currencyCode | string Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "securityPriceRequests": [
- {
- "externalId": "string",
- "marketCode": "string",
- "isin": "string"
}
], - "priceDate": "2023-09-15T09:10:08Z",
- "currencyCode": "string"
}{- "securityPrices": [
- {
- "isin": "string",
- "externalId": "string",
- "currencyCode": "string",
- "valuationDate": "2023-09-15T09:10:08Z",
- "marketCode": "string",
- "basePrice": 0,
- "price": 0,
- "validityDate": "2023-09-15T09:10:08Z",
- "isPricePercentage": true,
- "calculationPrice": 0
}
]
}Creates a new security.
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
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) |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "name": "New Security 7FT",
- "isActive": true,
- "isin": "7FT",
- "externalId": "ExtId-7FT",
- "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
}{- "id": 0
}Gets a security by ID and updates its' ESG components.
| securityId required | integer <int32> Security id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
request object
| esgComponents | Array of objects (ComponentScore) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "esgComponents": [
- {
- "id": 0,
- "score": 0
}
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Gets a security by ID and updates its' fees.
| securityId required | integer <int32> Security Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request object
| fees | Array of objects (Fee) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "fees": [
- {
- "id": 0,
- "isPercentage": true,
- "validFrom": "2023-09-15T09:10:08Z",
- "validTo": "2023-09-15T09:10:08Z",
- "feeTypeId": 0,
- "feeRecurrenceTypeKey": "Single",
- "feeDefinitions": [
- {
- "id": 0,
- "feeId": 0,
- "valueFrom": 0,
- "valueTo": 0,
- "feeValue": 0
}
]
}
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Gets a security by ID and updates its' ratings.
| securityId required | integer <int32> Security Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request object
| ratings | Array of objects (SecurityRating) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "ratings": [
- {
- "ratingAgencyId": 0,
- "ratingId": 0
}
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Gets a security by ID and updates its' stock exchanges. Mandatory Fields:
| securityId required | integer <int32> Security Id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
Request object
| stockExchanges | Array of objects (SecurityStockExchange) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "stockExchanges": [
- {
- "stockExchangeId": 0,
- "ticker": "string",
- "securityStockExchangeId": "string",
- "currencyId": 0,
- "priceFeedIntegrationIdentifierType": "string",
- "priceFeedIntegrationIdentifier": "string",
- "isDefault": true
}
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Modifies order thresholds associated with securities of a product.
| productId required | integer <int32> Product id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| securityThresholds | Array of objects (SecurityThreshold) Nullable |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "securityThresholds": [
- {
- "securityId": 0,
- "orderTypeId": "Buy",
- "orderThresholdTypeId": "SharesAmount",
- "orderThresholdValue": 0
}
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Creates order thresholds associated with securities of a product.
| productId required | integer <int32> Product id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| securityThresholds | Array of objects (SecurityThreshold) Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "securityThresholds": [
- {
- "securityId": 0,
- "orderTypeId": "Buy",
- "orderThresholdTypeId": "SharesAmount",
- "orderThresholdValue": 0
}
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Removes order thresholds associated with securities of a product.
| productId required | integer <int32> Product id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
request object
| thresholdsToRemove | Array of objects (SecurityOrderType) Nullable |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "thresholdsToRemove": [
- {
- "securityId": 0,
- "orderTypeId": "Buy"
}
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Searches for order thresholds associated with securities of a product.
| productId required | integer <int32> Product id |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
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" |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "page": 0,
- "pageSize": 0,
- "securityIds": [
- 0
], - "orderTypeId": "Buy",
- "orderThresholdTypeIds": [
- "SharesAmount"
]
}{- "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
}Delete an existing stock exchange
| stockExchangeId required | integer <int32> The id of the stock exchange. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Update an existing stock exchange
This API is deprecated. Use PATCH /v1.1/stockexchanges/{stockExchangeId} instead.
| stockExchangeId required | integer <int32> The id of the stock exchange. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
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) |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "marketCode": "@H5",
- "description": {
- "doUpdate": true,
- "value": [
- {
- "languageCode": "en",
- "value": "Stock Exchanged En"
}
]
}, - "countryId": {
- "doUpdate": true,
- "value": 42
}
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Update an existing stock exchange
| stockExchangeId required | integer <int32> The id of the stock exchange. |
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
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 |
No Content
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "marketCode": "@IK",
- "operatingMIC": "EW0U",
- "description": [
- {
- "languageCode": "en",
- "value": "Stock Exchanged En"
}
], - "countryId": 42,
- "updateProperties": [
- "CountryId",
- "Description",
- "OperatingMIC"
]
}{- "code": "BadRequest",
- "subCode": "NA",
- "message": "The request was not in the required format",
- "correlationId": "30d3ebc0b5cb47b0889850bbdfe4aec6"
}Create a new stock exchange
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
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 |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "marketCode": "7FH",
- "operatingMIC": "BTSL",
- "description": [
- {
- "languageCode": "en",
- "value": "Stock Exchanged En"
}
], - "countryId": 42
}{- "id": 0
}Search the stock exchanges configured in the application with filtering and sorting
| Accept-Language | string The ISO 639-1 language to use for localizable data. |
| 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 |
Success
Bad Request
Unauthorized
Forbidden
Not Found
UnprocessableEntity
Server Error
{- "page": 0,
- "pageSize": 0,
- "sortBy": "string",
- "sortOrder": "Ascending",
- "marketCode": "string",
- "operatingMIC": "string",
- "name": "string",
- "country": [
- 0
], - "ids": [
- 0
], - "search": "string"
}{- "results": [
- {
- "id": 0,
- "marketCode": "string",
- "operatingMIC": "string",
- "description": "string",
- "country": {
- "id": 0,
- "name": "string"
}
}
], - "page": 0,
- "pageSize": 0,
- "pageCount": 0,
- "totalCount": 0
}