Skip to main content

Securities Master Data API Specs

API docs by Redocly

Securities Master Data API (2.0)

Download OpenAPI specification:Download

E-mail: devcenter@koala.markets Terms of Service

Securities Master Data API Documentation

Securities Master Data V2

Update not accepted instrument by WMDaten

Allows updating a previously failed or not accepted instrument in the WMDaten system. Typically used when a submission is rejected due to validation or data quality issues, enabling retry after corrections.

Authorizations:
Bearer
path Parameters
tenantId
required
string
Example: whitebox
idType
required
string
Enum: "ISIN" "WKN" "EKN"
actualId
required
string
Request Body schema: application/json
required
financialObjectType
string
Enum: "Instrument" "Institution"
operationType
string
Enum: "Add" "Remove" "OneTime"

Responses

Request samples

Content type
application/json
{
  • "financialObjectType": "Instrument",
  • "operationType": "Add"
}

Response samples

Content type
application/json
{
  • "status": "100 CONTINUE",
  • "timestamp": "string",
  • "code": "string",
  • "message": "string",
  • "error": "string",
  • "exception": "string"
}

Delete instrument request from WMDaten

Deletes an existing instrument request from the WMDaten system. This operation is typically used to remove erroneous or obsolete instrument entries.

Authorizations:
Bearer
path Parameters
tenantId
required
string
Example: whitebox
idType
required
string
Enum: "ISIN" "WKN" "EKN"
actualId
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "100 CONTINUE",
  • "timestamp": "string",
  • "code": "string",
  • "message": "string",
  • "error": "string",
  • "exception": "string"
}

Retrieve list of WMDaten instruments

Fetches a paginated list of instruments created in the WMDaten system. Supports optional filters such as ID type, operation type, acceptance status, disabled status, and date range. Useful for browsing or auditing instrument records.

Authorizations:
Bearer
path Parameters
tenantId
required
string
Example: whitebox
query Parameters
idType
string
Enum: "ISIN" "WKN" "EKN"
operationType
string
Enum: "Add" "Remove" "OneTime"
isAccepted
boolean
isDisabled
boolean
dateStart
string
dateEnd
string
pageNumber
required
integer <int32>
Example: pageNumber=1

Page number

recordsPerPage
integer <int32>
Example: recordsPerPage=100

Records per page

Responses

Response samples

Content type
application/json
{
  • "pageNumber": 0,
  • "recordsPerPage": 0,
  • "totalRecordCount": 0,
  • "data": [
    ],
  • "lastPage": true
}

Create a new instrument request for WMDaten

Creates a new WMDaten instrument request. The request body must include all necessary instrument data. This endpoint is intended for onboarding new financial instruments into the system.

Authorizations:
Bearer
path Parameters
tenantId
required
string
Example: whitebox
Request Body schema: application/json
required
idType
string
Enum: "ISIN" "WKN" "EKN"
actualId
string
financialObjectType
string
Enum: "Instrument" "Institution"
operationType
string
Enum: "Add" "Remove" "OneTime"

Responses

Request samples

Content type
application/json
{
  • "idType": "ISIN",
  • "actualId": "string",
  • "financialObjectType": "Instrument",
  • "operationType": "Add"
}

Response samples

Content type
application/json
{
  • "idType": "ISIN",
  • "actualId": "string",
  • "financialObjectType": "Instrument",
  • "operationType": "Add",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedDate": "2019-08-24T14:15:22Z",
  • "isAccepted": true,
  • "errorMessageDetail": "string",
  • "isDisabled": true,
  • "processed": true,
  • "processedDate": "2019-08-24T14:15:22Z"
}

Get multiple WMDaten overview

Get given isin codes overview.

REMARK: If the instrument does not have source of event or source of date fields for the search, the service returns the section’s creation date or last updated date instead. In this case, the sourceOfDate attribute will be set to either CREATED_DATE or UPDATED_DATE if no suitable field is available.

Authorizations:
Bearer
path Parameters
tenantId
required
string
Example: whitebox
query Parameters
isinCodeList
required
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get WMDaten overview

Get the given isin code overview.

REMARK: If the instrument does not have source of event or source of date fields for the search, the service returns the section’s creation date or last updated date instead. In this case, the sourceOfDate attribute will be set to either CREATED_DATE or UPDATED_DATE if no suitable field is available.

Authorizations:
Bearer
path Parameters
tenantId
required
string
Example: whitebox
isinCode
required
string = 12 characters [A-Z]{2}[-]{0,1}[A-Z0-9]{9}[-]{0,1}[0-9]{1}$
Example: DE0007100000
query Parameters
ag
string
relevantDateFrom
string <date-time> = 10 characters ^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|...
Example: relevantDateFrom=2023-01-01
relevantDateTo
string <date-time> = 10 characters ^\d{4}\-(0?[1-9]|1[012])\-(0?[1-9]|[12][0-9]|...
Example: relevantDateTo=2023-01-10

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get list of WMDaten details

Get the details of given isin codes.

Authorizations:
Bearer
path Parameters
tenantId
required
string
Example: whitebox
query Parameters
idType
string
Enum: "Instrument" "Institution"
idList
required
Array of strings
ags
required
Array of strings
bids
required
Array of strings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get WMDaten details

Get the details of instrument or institution.

Authorizations:
Bearer
path Parameters
tenantId
required
string
Example: whitebox
id
required
string [ 6 .. 12 ] characters [A-Z]{2}[-]{0,1}[A-Z0-9]{9}[-]{0,1}[0-9]{1}|[...
ag
required
string
bid
required
string
query Parameters
idType
string
Default: "Instrument"
Enum: "Instrument" "Institution"

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "idType": "ISIN",
  • "ag": "string",
  • "bid": "string",
  • "lastModification": "2019-08-24T14:15:22Z",
  • "datFields": {
    },
  • "txtFields": {
    },
  • "table": {
    }
}

Securities Master Data

Update not accepted instrument by WMDaten

Allows updating a previously failed or not accepted instrument in the WMDaten system. Typically used when a submission is rejected due to validation or data quality issues, enabling retry after corrections.

Authorizations:
Bearer
path Parameters
idType
required
string
Enum: "ISIN" "WKN" "EKN"

The type of instrument identifier (e.g., ISIN, WKN, etc.) used to locate the request to update.

actualId
required
string
Example: DE0007100000

The actual identifier value of the instrument to update, based on the specified idType.

Request Body schema: application/json
required
financialObjectType
string
Enum: "Instrument" "Institution"
operationType
string
Enum: "Add" "Remove" "OneTime"

Responses

Request samples

Content type
application/json
{
  • "financialObjectType": "Instrument",
  • "operationType": "Add"
}

Delete instrument request from WMDaten

Deletes an existing instrument request from the WMDaten system. This operation is typically used to remove erroneous or obsolete instrument entries.

Authorizations:
Bearer
path Parameters
idType
required
string
Enum: "ISIN" "WKN" "EKN"

The type of identifier used for the instrument (e.g., ISIN, WKN)

actualId
required
string
Example: DE0007100000

The identifier value of the instrument to be deleted

Responses

Search available values for instrument filter fields

Returns grouped field values based on the provided filter field requests.

Authorizations:
Bearer
Request Body schema: application/json
required

A list of filter field queries specifying which field values to retrieve. Each item typically contains a field name and optional criteria.

Array
fieldName
string
filter
string
data
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve list of WMDaten instruments

Fetches a paginated list of instruments created in the WMDaten system. Supports optional filters such as ID type, operation type, acceptance status, disabled status, and date range. Useful for browsing or auditing instrument records.

Authorizations:
Bearer
query Parameters
idType
string
Enum: "ISIN" "WKN" "EKN"

Type of ID to filter instruments by, e.g., ISIN, WKN

operationType
string
Enum: "Add" "Remove" "OneTime"

Operation type (e.g., Add, Remove) used to filter instrument activity

isAccepted
boolean

Filter by acceptance status. true for accepted instruments only.

isDisabled
boolean

Filter by disabled status. true for disabled instruments only.

dateStart
string
Example: dateStart=2024-01-01

Start date for filtering instruments based on creation timestamp (format: yyyy-MM-dd)

dateEnd
string
Example: dateEnd=2024-12-31

End date for filtering instruments based on creation timestamp (format: yyyy-MM-dd)

pageNumber
required
integer <int32>
Example: pageNumber=1

Page number for pagination

recordsPerPage
integer <int32>
Example: recordsPerPage=100

Number of records per page

Responses

Response samples

Content type
application/json
{
  • "pageNumber": 0,
  • "recordsPerPage": 0,
  • "totalRecordCount": 0,
  • "data": [
    ],
  • "lastPage": true
}

Create a new instrument request for WMDaten

Creates a new WMDaten instrument request. The request body must include all necessary instrument data. This endpoint is intended for onboarding new financial instruments into the system.

Authorizations:
Bearer
Request Body schema: application/json
required
idType
string
Enum: "ISIN" "WKN" "EKN"
actualId
string
financialObjectType
string
Enum: "Instrument" "Institution"
operationType
string
Enum: "Add" "Remove" "OneTime"

Responses

Request samples

Content type
application/json
{
  • "idType": "ISIN",
  • "actualId": "string",
  • "financialObjectType": "Instrument",
  • "operationType": "Add"
}

Response samples

Content type
application/json
{
  • "idType": "ISIN",
  • "actualId": "string",
  • "financialObjectType": "Instrument",
  • "operationType": "Add",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "updatedDate": "2019-08-24T14:15:22Z",
  • "deletedDate": "2019-08-24T14:15:22Z",
  • "isAccepted": true,
  • "errorMessageDetail": "string",
  • "isDisabled": true,
  • "processed": true,
  • "processedDate": "2019-08-24T14:15:22Z"
}

Retrieve selected field values for a specific instrument

Returns only the specified fields from the WMDaten snapshot for the given instrument ISIN. This is useful when clients require a subset of data for performance or UI customization purposes.

Authorizations:
Bearer
path Parameters
isinCode
required
string = 12 characters [A-Z]{2}[-]{0,1}[A-Z0-9]{9}[-]{0,1}[0-9]{1}$
Example: DE0007100000

The ISIN (International Securities Identification Number) of the instrument. Must be exactly 12 characters.

Request Body schema: application/json
required

List of fields to retrieve for the specified ISIN. Each item includes a field identifier and optional parameters.

Array
fieldName
string

The internal field identifier to be retrieved from the WMDaten database.

datVal
string

The associated data value used for filtering or input. Often numeric or date-based.

txtVal
string

The associated textual value used for filtering or display. Often descriptive labels or codes.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Retrieve detailed WMDaten information for an instrument or institution

Returns comprehensive WMDaten data for the specified ID, which may refer to either a financial instrument or an institution. Optionally, a list of specific field identifiers can be provided to retrieve only targeted data elements.

Authorizations:
Bearer
path Parameters
id
required
string [ 6 .. 12 ] characters [A-Z]{2}[-]{0,1}[A-Z0-9]{9}[-]{0,1}[0-9]{1}$|...
Example: DE0007100000

Unique identifier for the instrument or institution. If idType is 'Instrument', this must be an ISIN. If idType is 'Institution', this must be a WKN.

query Parameters
idType
string
Default: "Instrument"
Enum: "Instrument" "Institution"
Example: idType=Instrument

Type of object the ID refers to. Can be 'Instrument' or 'Institution'. Defaults to 'Instrument' if not specified.

fields
Array of strings

Optional list of field identifiers to filter the response.

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "idType": "ISIN",
  • "name": "string",
  • "section": [
    ]
}

Retrieve instrument or institution definitions

Returns a paginated list of financial instruments or institutions from the WM Daten database. You can filter results by type and an optional search term.

Authorizations:
Bearer
query Parameters
idType
string
Default: "Instrument"
Enum: "Instrument" "Institution"
Example: idType=Instrument

Specifies whether to return financial instruments or institutions. Default is 'Instrument'.

page
required
integer <int32> [ 1 .. 2147483647 ]
Example: page=1

Page number for paginated results. Must be greater than or equal to 1.

recordsPerPage
integer <int32> [ 1 .. 2147483647 ]
Example: recordsPerPage=20

Number of records to return per page. Optional. If not provided, a default will be used.

searchParameter
string
Example: searchParameter=DE0007100000

Optional search term to filter results by name or identifier.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve instrument section details with field explanations

Fetches detailed section-level data and corresponding field metadata for one or more ISINs. The response includes structured information that helps consumers interpret the data fields within each section.

Authorizations:
Bearer
query Parameters
isinCodes
required
Array of strings
Example: isinCodes=DE0007100000&isinCodes=US0378331005

List of ISINs (International Securities Identification Numbers) to retrieve section data for. Each value must be exactly 12 characters long and follow the standard ISIN format.

ags
required
Array of strings
Items Enum: "B" "C" "D" "E" "G" "H" "I" "J" "K" "M" "P" "Q" "R" "U" "V" "X"
Example: ags=G&ags=E

List of section identifiers (AG codes) for which data and explanations are requested. Each identifier corresponds to a specific section in the WMDaten structure.

sectionFilter
required
string
Enum: "all" "latest"

Determines which section records to return: all records or only the latest ones.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve available WMDaten filter fields

Provides a list of fields that can be used for filtering WMDaten data in search or query operations.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve available field codes

Returns a complete list of available field identifiers from the WMDaten system.

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]