v1

latestOpenAPI 3.1.02026-07-2694207444.7 KB
Portfolio Details

Portfolio Details v2

Returns a list of trading in EUR portfolios available to the current logged in user and relevant to the EPAD market.

Response field descriptions

  • permission: portfolio permission
    • WRITE - the logged in user has permission to submit and/or modify orders for the portfolio
    • READ - the logged in user can only view orders for the portfolio
  • portfolio: identifier of the portfolio
  • nasdaqClearingAccount: account code to which all trades concluded in the portfolio will be reported at Nasdaq
  • nasdaqCapacity: the role in which the trades are being made, 'Principal' or 'Agent'
  • nasdaqClientQualification: Nasdaq client identifier qualification to be used when reporting trades done, 'Person' or 'Company'
  • nasdaqClientId: Nasdaq client identifier to be used when registering trades done in the capacity of Agent
  • euronextClearingAccount: account code to which all trades concluded in the portfolio will be reported at Euronext
  • euronextClearingAccountType: account type to which all trades concluded in the portfolio will be reported at Euronext, 'Client' or 'House'
  • euronextCapacity: the role in which the trades are being made, 'Principal' or 'Agent'
  • euronextClientId: Euronext client identifier to be used when registering trades done in the capacity of Agent
  • name: portfolio name
  • shortName: portfolio short name
  • companyName: company to which the portfolio belongs to
  • validFrom: start date and time of portfolio validity
  • validTo: end date and time of portfolio validity
  • state: state of the portfolio, can be activated or deactivated
  • deleted: true - portfolio is deleted, false - portfolio is not deleted
  • areas: a list of areas which belong to the portfolio. Each area includes:
    • areaCode: bidding zone code
    • validFrom: start date and time of area validity
    • validTo: end date and time of area validity
get/api/v2/portfolios

Response

OK

permission'None' | 'READ' | 'WRITE' required
portfoliostring nullable required
nasdaqClearingAccountstring nullable
nasdaqCapacity'NotSet' | 'Principal' | 'Agent'
nasdaqClientQualification'Person' | 'Firm'
nasdaqClientIdstring nullable
euronextClearingAccountstring nullable
euronextClearingAccountType'NotSet' | 'Client' | 'House'
euronextCapacity'NotSet' | 'Principal' | 'Agent'
euronextClientIdstring nullable
namestring nullable required
shortNamestring nullable required
companyNamestring nullable required
validFromstring date-time required
validTostring date-time required
state'None' | 'ACTI' | 'IACT' | 'HIBE' required
deletedboolean