Nordnet API
Overview
This documentation describes the REST API for the Nordnet API.
Version information
Version : 2
URI scheme
Host : nordnet.se
BasePath : /api/2
Schemes : HTTP
Tags
-
accounts : Customer account operations
-
authentication : Authentication queries
-
company_data : Company data fundamentals
-
content : Dynamic content
-
countries : Country queries
-
fees : Fee and kickback information
-
fundguidance : Fund guidance flow
-
generation_savings : Generation savings
-
indicators : Indicator queries
-
instrument_search : Search, filter and sort instruments
-
instruments : Instrument queries
-
lists : Instrument lists queries
-
login : User session operations
-
markets : Marketplace queries
-
messages : Handle messaging with customers
-
news : News queries
-
news_sources : News source queries
-
price_alarms : Manage price alarms for a customer
-
realtime_access : Realtime access queries
-
suitability : Instrument suitability
-
system : System queries
-
tick_sizes : Tick size queries
-
tradables : Tradable queries
Paths
Get system status info
GET /api/2
Description
Information about the system status can be retrieved by this HTTP request. This is the only service that can be called without authentication.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
system
Get user accounts
GET /api/2/accounts
Description
Returns a list of accounts that the user has access to
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Query |
include_credit_accounts |
Filter in credit accounts. |
boolean |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Account > array |
204 |
No content |
No Content |
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get Netfonds transactions by Netfonds account id
GET /api/2/accounts/transactions/netfonds
Description
Get Netfonds transactions by Netfonds account id
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
from |
The start date, defaults to 3 months before Netfonds migration |
string(date) |
|
Query |
limit |
Max number of transactions to return, default 50 |
integer(int64) |
|
Query |
netfonds_account_id |
The Netfonds account id |
string |
|
Query |
offset |
Used together with limit to create pagination. This is the first transaction to show. Default 0. |
integer(int64) |
|
Query |
to |
The end date, defaults to just after Netfonds migration |
string(date) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get account information summary
GET /api/2/accounts/{accid}
Description
The account info summary gives details of the account. Deprecated: Please use /api/2/accounts/{accid}/info instead
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
List charge groups that given accounts is allowed to have
GET /api/2/accounts/{accid}/allowed_charge_groups
Description
List charge groups that given accounts is allowed to have
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get archive messages for given account
GET /api/2/accounts/{accid}/archive/messages
Description
Archive messages are fetched from datawarehouse db
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Path |
accid |
One or more account id that identifies the accounts. Some systems can or must use the accno as accid. Multiple accid should be comma separated |
< integer > array |
|
Query |
limit |
The maximum amount of archive messages to retrieve |
integer(int32) |
|
Query |
offset |
The index of the first archive message to retrieve from archive messages list |
integer(int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< ArchiveMessage > array |
204 |
No content |
No Content |
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get count of archive messages
GET /api/2/accounts/{accid}/archive/messages/count
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
One or more account id that identifies the accounts. Some systems can or must use the accno as accid. Multiple accid should be comma separated |
< integer > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
404 |
Not Found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get a single archive message
GET /api/2/accounts/{accid}/archive/messages/{message_id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
One or more account id that identifies the accounts. Some systems can or must use the accno as accid. Multiple accid should be comma separated |
< integer > array |
Path |
message_id |
Id of a message |
integer(int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
404 |
Not Found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Current charge group for a given account number
GET /api/2/accounts/{accid}/charge_group
Description
Current charge group for a given account number
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Change charge group for a given account
PUT /api/2/accounts/{accid}/charge_group
Description
Change charge group for a given account, this should not be used for Swedish accounts
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
FormData |
charge_group_id |
id of charge group to change into |
integer(int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
No Content |
204 |
No content |
No Content |
400 |
Missing charge_group_id |
No Content |
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get upcoming fees and refunds summary
GET /api/2/accounts/{accid}/fees_and_refunds_summary
Description
Get upcoming fees and refunds summary correspond to given account. The fees in summary are some of the selected fees exposed, including but not limited to platform fee.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Enter fund order
POST /api/2/accounts/{accid}/fund/orders
Description
Enter a new fund order. Only daily traded funds is allowed in the API. Fund order entries is only allowed for some systems
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
FormData |
amount |
If side is BUY the amount should be given in currency. If side is SELL the amount should be empty |
integer(int64) |
FormData |
instrument_id |
The instrument id of the fund |
integer(int64) |
FormData |
side |
BUY or SELL |
enum (BUY, SELL) |
FormData |
volume |
If side is SELL the volume should be specified. If side is BUY the volume should be empty |
number(double) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get fund orders
GET /api/2/accounts/{accid}/fund/orders
Description
Get fund orders belonging to the account
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< FundOrder > array |
204 |
No content |
No Content |
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Validate fund order
POST /api/2/accounts/{accid}/fund/orders/validate
Description
Validate a new fund order
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
FormData |
accno |
The account in use |
integer(int64) |
FormData |
amount |
If side is BUY the amount should be given in currency. If side is SELL the amount should be empty |
integer(int64) |
FormData |
instrument_id |
The instrument id of the fund |
integer(int64) |
FormData |
side |
BUY or SELL |
enum (BUY, SELL) |
FormData |
volume |
If side is SELL the volume should be specified. If side is BUY the volume should be empty |
number(double) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get one fund order
GET /api/2/accounts/{accid}/fund/orders/{order_id}
Description
Get one fund orders belonging to the account
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
Path |
order_id |
The order id of the fund |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< FundOrder > array |
204 |
No content |
No Content |
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Delete a fund order
DELETE /api/2/accounts/{accid}/fund/orders/{order_id}
Description
Delete a fund order
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
Path |
order_id |
The fund order id |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get fund universe for an account
GET /api/2/accounts/{accid}/fund_universe
Description
Get fund universe for an account
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< FundUniverseModel > array |
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
404 |
No universe found |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get account information summary
GET /api/2/accounts/{accid}/info
Description
The account info summary gives details of one or more account.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
One or more account id that identifies the accounts. Some systems can or must use the accno as accid. Multiple accid should be comma separated |
< integer > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< AccountInfo > array |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get account ledgers
GET /api/2/accounts/{accid}/ledgers
Description
Information about the currency ledgers of an account
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Create messages
POST /api/2/accounts/{accid}/messages
Description
Send a message to customer service
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
One or more account id that identifies the accounts. Some systems can or must use the accno as accid. Multiple accid should be comma separated |
< integer > array |
FormData |
attachment_id |
id of attatchemt uploaded using the media api |
integer(int32) |
FormData |
category |
message category |
string |
FormData |
message |
the message |
string |
FormData |
message_id |
The message you are responding to |
integer(int32) |
FormData |
subject |
subject of the message |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
400 |
Bad Request |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get messages for accounts
GET /api/2/accounts/{accid}/messages
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
One or more account id that identifies the accounts. Some systems can or must use the accno as accid. Multiple accid should be comma separated |
< integer > array |
Query |
mailbox |
Select if inbox or outbox is returned |
enum (INBOX, OUTBOX) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< IndexMessage > array |
204 |
No content |
No Content |
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get a single message
GET /api/2/accounts/{accid}/messages/{message_id}
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
One or more account id that identifies the accounts. Some systems can or must use the accno as accid. Multiple accid should be comma separated |
< integer > array |
Path |
message_id |
a id of a message |
integer(int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
404 |
Not Found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Enter order
POST /api/2/accounts/{accid}/orders
Description
Enter a new order, market_id + identifier is the identifier of the tradable.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
|
FormData |
activation_condition |
Used for stop loss orders. STOP_ACTPRICE_PERC - Trailing stop loss. The order is activated when the price changes by percent. The fields target_value, trigger_value and trigger_condition is required and the price field should not be set STOP_ACTPRICE - The order is activated when the market price of the instrument reaches a trigger price. The fields trigger_value, trigger_condition and price is required MANUAL - The order is inactive in the Nordnet system until it is manually activated by a user OCO_STOP_ACTPRICE - One cancels other orders - Our implementation is one normal order and one stop loss order. If the real order is executed the stop loss is cancelled. If the stop loss triggers the normal order is canceled. This combination is always displayed as one order |
string |
|
FormData |
currency |
The currency that the instrument is traded in |
string |
|
FormData |
identifier |
Nordnet tradable identifier |
string |
|
FormData |
market_id |
Nordnet market identifier |
integer(int64) |
|
FormData |
open_volume |
The visible part of an iceberg order. If left out the whole volume of the order is visible on the market. This field is only allowed if the order type is LIMIT or NORMAL |
integer(int64) |
|
FormData |
order_type |
NORMAL is the default if order_type is left out, when using NORMAL the system guess the order type based on used parameters.In order to get better parameter validation and to ensure that the order type is the desired the client should not use NORMAL, please user the intended order type. NORMAL will be deprecated in future versions |
enum (FAK, FOK, NORMAL, LIMIT, STOP_LIMIT, STOP_TRAILING, OCO) |
|
FormData |
price |
The price limit of the order |
number(double) |
|
FormData |
reference |
Free text reference for the order. Intended for the end user |
string |
|
FormData |
side |
BUY or SELL |
enum (BUY, SELL) |
|
FormData |
target_value |
Only used when type is STOP_ACTPRICE_PERC or OCO_STOP_ACTPRICE. This is the price on the market.If type is STOP_ACTPRICE_PERC the value is given in percent. The price will be trailing_value + (target_value% of trailing_value). If type is OCO_STOP_ACTPRICE the price is a fixed price |
number(double) |
|
FormData |
trigger_condition |
The comparision that should be used on trigger_value <= or >= |
string |
|
FormData |
trigger_value |
If type is STOP_ACTPRICE_PERC the value is the given in percent. Minimum value is 1 for STOP_ACTPRICE_PERC. If type is STOP_ACTPRICE the value is a fixed price |
number(double) |
|
FormData |
valid_until |
Date on format YYYY-MM-DD, if left out the order is a day order - same behavior as if valid_date should be set to today. Smart-orders can only be day orders |
string(date) |
|
FormData |
volume |
The volume of the order |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get orders
GET /api/2/accounts/{accid}/orders
Description
Get all orders belonging to an account.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Path |
accid |
One or more account id that identifies the accounts. Some systems can or must use the accno as accid. Multiple accid should be comma separated |
< integer > array |
|
Query |
deleted |
Include orders deleted today |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Order > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Modify an order
PUT /api/2/accounts/{accid}/orders/{order_id}
Description
Modify price and or volume on an order
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
Path |
order_id |
The order to modify |
integer(int64) |
FormData |
currency |
The currency of the instrument. Needed when the price is changed |
string |
FormData |
open_volume |
The new open volume |
integer(int64) |
FormData |
price |
The new price. If left out the price is not changed |
number(double) |
FormData |
volume |
The new volume |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
404 |
Order not found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Delete an order
DELETE /api/2/accounts/{accid}/orders/{order_id}
Description
Delete an order
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
Path |
order_id |
The order to delete |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Activate an order
PUT /api/2/accounts/{accid}/orders/{order_id}/activate
Description
Activate an inactive order. Please note that it is not possible to deactivate an order. The order must be entered as inactive
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
Path |
order_id |
The order to activate |
< integer(int64) > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< OrderReply > array |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get a list of winners and losers for the given accid(s)
GET /api/2/accounts/{accid}/position_performance
Description
Get a list of winners and losers for the given accid(s). Multiple accounts can be queried.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
One or more account id that identifies the accounts. Some systems can or must use the accno as accid. Multiple accid should be comma separated |
< integer > array |
Query |
exchange_traded |
True to fetch only exchange traded products, false to fetch funds, default is true. |
boolean |
Query |
limit |
Max length of winners/losers list, default 5 |
integer(int32) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get account positions
GET /api/2/accounts/{accid}/positions
Description
Returns a list of all positions of the given accounts
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Path |
accid |
One or more account id that identifies the accounts. Some systems can or must use the accno as accid. Multiple accid should be comma separated |
< integer > array |
|
Query |
include_instrument_loans |
Include instrument loan positions |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Position > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get trades
GET /api/2/accounts/{accid}/trades
Description
Get all trades belonging to an account.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Path |
accid |
One or more account id that identifies the accounts. Some systems can or must use the accno as accid. Multiple accid should be comma separated |
< integer > array |
|
Query |
days |
Number of days to look for trades. Default is 0. 0 means trades from today. Max is 7 days |
integer(int64) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Trade > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
User is logged in but user or system does not have privileges to use this endpoint |
No Content |
404 |
Account not found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
accounts
Get the JSON Web Key Set
GET /api/2/authentication/jwks
Description
Returns the active JSON Web Key Set used to sign the JWT’s issued by NNAPI.
The keys are used to verify the integrity of the JWT’s by verifying the signature.
The response follows the https://tools.ietf.org/html/rfc7517 standard.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
204 |
No content |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
authentication
Refresh a JWT token
POST /api/2/authentication/jwt/refresh
Description
Returns a fresh JWT if the refresh token (NNAPI session) is still valid.
The JWT is issued as a cookie for web based systems and as a header called nn-jwt for token based systems.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
authentication
Get corporate calendar for a company
GET /api/2/company_data/corporatecalendar/{instrument_id}
Description
Corporate Calender for an instrument_id, returned in requested 'Accept-Language', if available. Only works for stocks
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
instrument_id |
instrument_id |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< CompanyDataCorporatecalendar > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
Forbidden. Lacking access for the resource |
|
404 |
Not found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
company_data
Get dividends for a company
GET /api/2/company_data/dividends/{instrument_id}
Description
Dividends for supplied instrument_id. Only works for stocks
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
instrument_id |
instrument_id |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< CompanyDataDividends > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
Forbidden. Lacking access for the resource |
|
404 |
Not found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
company_data
Get key figures for a company.
GET /api/2/company_data/keyfigures/{instrument_id}
Description
Key figures for supplied instrument_id, Only works for stocks
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
instrument_id |
instrument_id |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
Forbidden. Lacking access for the resource |
|
404 |
Not found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
company_data
Get a basic company summary.
GET /api/2/company_data/summary/{instrument_id}
Description
Company summary for supplied instrument_id, returned in requested 'Accept-Language', if available. Only works for stocks
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
instrument_id |
instrument_id |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
Forbidden. Lacking access for the resource |
|
404 |
Not found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
company_data
Get yearly financial figures for the company
GET /api/2/company_data/yearlyfinancial/{instrument_id}
Description
Yearly financials for supplied instrument_id, Only works for stocks
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
instrument_id |
instrument_id |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
Forbidden. Lacking access for the resource |
|
404 |
Not found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
company_data
Get agreements
GET /api/2/content/onboarding/agreement/bundles
Description
Get agreement PDF bundles for signing. This endpoint is not session controlled.
<b>NOTE</b>: This endpoint will be removed at a later stage when we figure out how to handle content that doesn’t need authorization.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Query |
country |
The country where the PDF is valid |
< string > array |
Query |
lang |
The lang of the PDF |
< string > array |
Query |
pdf_id |
The id of PDF:s to bundle, comma separate multiple inputs |
< string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/pdf
Tags
-
content
Get all countries
GET /api/2/countries
Description
Get a list of all countries in the system. Please note that trading is not available everywhere
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Country > array |
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
countries
Get country
GET /api/2/countries/{country}
Description
Lookup one or more countries by country code. Multiple countries can be queried at the same time by comma separating the country codes.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
country |
The country_code to lookup |
< string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Country > array |
204 |
No content |
No Content |
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
countries
Create an approximation for an investment
POST /api/2/fees/investment_approximation
Description
The approximation assumes linear market value changes.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Body |
body |
An investment approximation request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< InvestmentApproximationResponse > array |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
422 |
Unprocessable entity, semantic error |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
fees
Create an approximation for liquidating an investment
POST /api/2/fees/liquidation_approximation
Description
The approximation assumes linear market value changes.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Body |
body |
An liquidation approximation request |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< LiquidationApproximationResponse > array |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
422 |
Unprocessable entity, semantic error |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
fees
Get resulting funds in guidance flow
POST /api/2/fundguidance
Description
Returns propsed funds according to supplied search criterias
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Body |
body |
body for getting proposed funds |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< FundGuidanceCategoryResponse > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
fundguidance
Get list of all funds
POST /api/2/fundguidance/instrument
Description
Returns all funds according to supplied search criterias
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Body |
body |
body for getting funds |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
fundguidance
Portfolios for Fund guidance flow
GET /api/2/fundguidance/portfolios
Description
Returns propsed fund portfolios
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Query |
horizon |
Specifies which investment horizon to use. |
enum (SHORT, MEDIUM, LONG) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
fundguidance
Questions for Fund guidance flow
GET /api/2/fundguidance/questions
Description
Returns all questions for the Fund guidance flow for user’s country.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
fundguidance
Prognosticate how generation savings would look like if it was active for an account
GET /api/2/generation_savings/{accid}/prognosticate
Description
Prognosticate how generation savings would look like if it was active for an account
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Ok |
< GenerationSavingsModel > array |
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
generation_savings
Get indicators
GET /api/2/indicators
Description
Returns a list indicators that the user has access to
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Indicator > array |
204 |
No content |
No Content |
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
indicators
Get indicator info
GET /api/2/indicators/{indicator}
Description
Returns info of one or more indicators
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
indicator |
The indicator on the format [src]:[identifier], comma separate multiple inputs |
< string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Indicator > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
indicators
Returns instrument attributes, which can be retrieved from the search/query endpoints..
GET /api/2/instrument_search/attributes
Description
Exposes available attributes for instrument-search
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
apply_filters |
Specifies filters to apply when looking for valid attribute values |
string |
|
Query |
attribute_group |
Only return attributes for the specified attributeGroup(s) |
< enum (EXCHANGE_INFO, HISTORICAL_RETURN_INFO, INSTRUMENT_INFO, KEY_RATIOS_INFO, PRICE_INFO, MARKET_INFO, OPTION_INFO, UNDERLYING_INFO, FUND_INFO, PRICE_KO_INFO, DERIVATIVE_INFO, ETP_INFO, KO_INFO, CERTIFICATES_INFO, STATISTICAL_INFO) > array |
|
Query |
entity_type |
Only return attributes for the specified entityType |
enum (STOCKLIST, OPTIONLIST, FUTUREFORWARDLIST, BULLBEARLIST, MINIFUTURELIST, UNLIMITEDTURBOLIST, WARRANTLIST, ASSET, FUNDLIST, DANISHINVESTFUNDLIST, ETFLIST) |
|
Query |
expand |
Only expand attributes values for the listed attributes (default all) |
< string > array |
|
Query |
only_filterable |
Only return attributes which are filterable |
boolean |
|
Query |
only_returnable |
Only return attributes which are returnable |
boolean |
|
Query |
only_sortable |
Only return attributes which are sortable |
boolean |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instrument_search
Search, filter and sort instruments within the Bull & Bear entity type.
GET /api/2/instrument_search/query/bullbearlist
Description
Specifically targeted for the purpose of displaying Bull & Bear certificates to the end-user, grouped by lists. To only return instruments in 'Nordnet Markets' use the apply_filter: nordnet_markets=true Access to realtime prices is handled based on access rights and in case of realtime prices being returned, realtime snaptshot access logs will be produced.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
apply_filters |
Specifies which filters to apply to the search. |
string |
|
Query |
free_text_search |
Free text search for instrument name, symbol and ISIN code. Also for underlying name and symbol. |
string |
|
Query |
limit |
Max number of items returned. |
integer(int32) |
|
Query |
offset |
Offset is used together with limit to create pagination. |
integer(int32) |
|
Query |
sort_attribute |
Set which field to sort by. |
string |
|
Query |
sort_order |
Sort order, 'asc' or 'desc'. |
enum (asc, desc) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instrument_search
Search, filter and sort instruments within the danish investment fundlist entity type.
GET /api/2/instrument_search/query/danishinvestfundlist
Description
This endpoint is specifically targeted for the purpose of displaying danish investment funds to the end-user. Access to realtime prices is handled based on access rights and in case of realtime prices being returned, realtime snaptshot access logs will be produced. Note that investment funds only are available for danish customers.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
apply_filters |
Specifies which filters to apply to the search. |
string |
|
Query |
free_text_search |
Free text search for name, symbol and category. Also ISIN but only exact matches. |
string |
|
Query |
limit |
Max number of items returned. |
integer(int32) |
|
Query |
offset |
Offset is used together with limit to create pagination. |
integer(int32) |
|
Query |
sort_attribute |
Set which field to sort by. |
string |
|
Query |
sort_order |
Sort order, 'asc' or 'desc'. |
enum (asc, desc) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instrument_search
Search, filter and sort ETF.
GET /api/2/instrument_search/query/etflist
Description
This endpoint is specifically targeted for the purpose of displaying ETF. Access to realtime prices is handled based on access rights and in case of realtime prices being returned, realtime snaptshot access logs will be produced.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
apply_filters |
Specifies which filters to apply to the search. |
string |
|
Query |
free_text_search |
Free text search for name, symbol and category. Also ISIN but only exact matches. |
string |
|
Query |
limit |
Max number of items returned. |
integer(int32) |
|
Query |
offset |
Offset is used together with limit to create pagination. |
integer(int32) |
|
Query |
sort_attribute |
Set which field to sort by. |
string |
|
Query |
sort_order |
Sort order, 'asc' or 'desc'. |
enum (asc, desc) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instrument_search
Search, filter and sort instruments within the fundlist entity type.
GET /api/2/instrument_search/query/fundlist
Description
This endpoint is specifically targeted for the purpose of displaying funds to the end-user.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
apply_filters |
Specifies which filters to apply to the search. |
string |
|
Query |
attributes |
Specifies which attributes that should be added to the response. |
< string > array |
|
Query |
free_text_search |
Free text search for instrument name, symbol, ISIN or fund category. |
string |
|
Query |
limit |
Max number of items returned. |
integer(int32) |
|
Query |
offset |
Offset is used together with limit to create pagination. |
integer(int32) |
|
Query |
sort_attribute |
Set which field to sort by. |
string |
|
Query |
sort_order |
Sort order, 'asc' or 'desc'. |
enum (asc, desc) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instrument_search
Search, filter and sort indexes.
GET /api/2/instrument_search/query/indicator
Description
This endpoint is specifically targeted for the purpose of displaying indexes to the end-user. Access to realtime prices is handled based on access rights and in case of realtime prices being returned, realtime snaptshot access logs will be produced.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
apply_filters |
Specifies which filters to apply to the search. |
string |
|
Query |
entity_type |
Specifies which entity type to return |
enum (COMMODITY, CURRENCY, INDEX, INTEREST) |
|
Query |
free_text_search |
Free text search for name, symbol and ISIN code |
string |
|
Query |
limit |
Max number of items returned. |
integer(int32) |
|
Query |
offset |
Offset is used together with limit to create pagination. |
integer(int32) |
|
Query |
sort_attribute |
Set which field to sort by. |
string |
|
Query |
sort_order |
Sort order, 'asc' or 'desc'. |
enum (asc, desc) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instrument_search
Fetch basic information about instruments
GET /api/2/instrument_search/query/instrument
Description
Fetch instrument information based on applied search fields.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
apply_filters |
Specifies which filters to apply to the search. |
string |
|
Query |
attribute_groups |
Only return attributes for the specified attribute_groups. |
< enum (EXCHANGE_INFO, INSTRUMENT_INFO, PRICE_INFO, HISTORICAL_RETURN_INFO) > array |
|
Query |
attributes |
Specifies which attributes that should be added to the response. |
< string > array |
|
Query |
free_text_search |
Free text search for instrument name, symbol, fund category and ISIN code. Also for underlying name and symbol. |
string |
|
Query |
limit |
Max number of items returned. |
integer(int32) |
|
Query |
offset |
Offset is used together with limit to create pagination. |
integer(int32) |
|
Query |
sort_attribute |
Set which field to sort by. |
string |
|
Query |
sort_order |
Sort order, 'asc' or 'desc'. |
enum (asc, desc) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instrument_search
Search, filter and sort instruments within the Mini future entity type.
GET /api/2/instrument_search/query/minifuturelist
Description
This endpoint is specifically targeted for the purpose of displaying Minifuture instruments to the end-user, grouped by lists. To only return instruments in 'Nordnet Markets' use the apply_filter: nordnet_markets=true Access to realtime prices is handled based on access rights and in case of realtime prices being returned, realtime snaptshot access logs will be produced.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
apply_filters |
Specifies which filters to apply to the search. |
string |
|
Query |
free_text_search |
Free text search for name, symbol and ISIN code |
string |
|
Query |
limit |
Max number of items returned. |
integer(int32) |
|
Query |
offset |
Offset is used together with limit to create pagination. |
integer(int32) |
|
Query |
sort_attribute |
Set which field to sort by. |
string |
|
Query |
sort_order |
Sort order, 'asc' or 'desc'. |
enum (asc, desc) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instrument_search
Fetch the option pair (put/call) list given an underlying instrument and expire date.
GET /api/2/instrument_search/query/optionlist/pairs
Description
This endpoint is specifically targeted for the purpose of displaying option pairs to the end-user, grouped by underlying instrument and expire date. Access to realtime prices is handled based on access rights and in case of realtime prices being returned, realtime snapshot access logs will be produced.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Query |
currency |
Search for options with the given currency. |
string |
Query |
expire_date |
Search for options with the given expiration date. |
integer(int64) |
Query |
underlying_symbol |
Search for options with the given underlying instrument symbol. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instrument_search
Fetch information about an underlying instrument as well as its related instruments (futures and forwards) for the given expire date.
GET /api/2/instrument_search/query/optionlist/related
Description
This endpoint is specifically targeted for the purpose of displaying related information about an option underlying instrument to the end-user, grouped by the currency, underlying instrument and expire date. Access to realtime prices is handled based on access rights and in case of realtime prices being returned, realtime snapshot access logs will be produced.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Query |
currency |
Search for underlying and related instruments with the given currency. |
string |
Query |
expire_date |
Search for underlying and related instruments with the given expiration date. |
integer(int64) |
Query |
symbol |
Search for underlying and related instruments with the given expiration date, where the underlying instrument has the given symbol. |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instrument_search
Search for instruments within the stocklist entity type.
GET /api/2/instrument_search/query/stocklist
Description
Provides search, filter and sort functionality for instruments of stocklist entity type.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
apply_filters |
Specifies which filters to apply to the search. |
string |
|
Query |
attribute_groups |
Only return attributes for the specified attributeGroups |
< enum (DOCUMENT_INFO, EXCHANGE_INFO, HISTORICAL_RETURN_INFO, INSTRUMENT_INFO, KEY_RATIOS_INFO, PRICE_INFO, MARKET_INFO) > array |
|
Query |
attributes |
Specifies which attributes that should be added to the response. |
< string > array |
|
Query |
free_text_search |
Free text search for instrument name, symbol and ISIN code. |
string |
|
Query |
limit |
Max double of items returned. |
integer(int32) |
|
Query |
offset |
Offset is used together with limit to create pagination. |
integer(int32) |
|
Query |
sort_attribute |
Set which field to sort by. |
string |
|
Query |
sort_order |
Sort order, 'asc' or 'desc'. |
enum (asc, desc) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instrument_search
Search, filter and sort instruments within the Unlimited Turbo entity type.
GET /api/2/instrument_search/query/unlimitedturbolist
Description
This endpoint is specifically targeted for the purpose of displaying Unlimited Turbo instruments to the end-user, grouped by lists.To only return instruments in 'Nordnet Markets' use the apply_filter: nordnet_markets=true.Access to realtime prices is handled based on access rights and in case of realtime prices being returned, realtime snaptshot access logs will be produced.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
apply_filters |
Specifies which filters to apply to the search |
string |
|
Query |
free_text_search |
Free text search for name, symbol and ISIN code |
string |
|
Query |
limit |
Max number of items returned. |
integer(int32) |
|
Query |
offset |
Offset is used together with limit to create pagination |
integer(int32) |
|
Query |
sort_attribute |
Set which field to sort by |
string |
|
Query |
sort_order |
Sort order, 'asc' or 'desc' |
enum (asc, desc) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instrument_search
Search, filter and sort instruments within the Warrant entity type.
GET /api/2/instrument_search/query/warrantlist
Description
This endpoint is specifically targeted for the purpose of displaying Warrant instruments to the end-user, grouped by lists. To only return instruments in 'Nordnet Markets' use the apply_filter: nordnet_markets=true Access to realtime prices is handled based on access rights and in case of realtime prices being returned, realtime snaptshot access logs will be produced.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
apply_filters |
Specifies which filters to apply to the search. |
string |
|
Query |
free_text_search |
Free text search for name, symbol and ISIN code |
string |
|
Query |
limit |
Max number of items returned. |
integer(int32) |
|
Query |
offset |
Offset is used together with limit to create pagination. |
integer(int32) |
|
Query |
sort_attribute |
Set which field to sort by. |
string |
|
Query |
sort_order |
Sort order, 'asc' or 'desc'. |
enum (asc, desc) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instrument_search
Retrieve winners/losers for instruments of type stocks.
GET /api/2/instrument_search/query/winnerslosers
Description
This endpoint is specifically targeted for displaying best and worst stocks to the end-user, grouped by exchange lists.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
exchange_list |
The list of the exchange where the instruments are traded. |
string |
|
Query |
limit |
No of winners and losers. Default 7 |
integer(int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instrument_search
Returns related instruments
GET /api/2/instrument_search/relations/{instrument_id}
Description
Currently only provided for instrument with fund data (Funds, ETFs, PINVs)
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Path |
instrument_id |
instrument_id |
integer(int64) |
|
Query |
limit |
Max number of results to return |
integer(int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< RelatedInstrumentsResult > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instrument_search
Instrument search
GET /api/2/instruments
Description
Free text search. A list of instruments is returned
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
fuzzy |
To perform a approximate string search, set fuzzy to true |
boolean |
|
Query |
instrument_group_type |
Instrument group type to search for. If empty all instrument group types is used. Multiple group types should be comma separated |
< string > array |
|
Query |
limit |
Max number of items in the reply. Max value is 100. Default is 100 |
integer(int64) |
|
Query |
offset |
Used together with limit to create pagination. This is the first instrument to show. Defaults to 0 |
integer(int64) |
|
Query |
query |
The query string |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Instrument > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instruments
Instrument lookup
GET /api/2/instruments/lookup/{lookup_type}/{lookup}
Description
Lookup specfic instrument with prededfined fields. Please note that this is not a search, only exact matches is returned.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
lookup |
If lookup_type is market_id_identifier the lookup must be on the format [market_id]:[identifier], if lookup_type is isin_code_currency_market_id the lookup format is [isin]:[currency]:[market_id] |
< string > array |
Path |
lookup_type |
The lookup type to use |
enum (market_id_identifier, isin_code_currency_market_id) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Instrument > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instruments
Get instrument sectors
GET /api/2/instruments/sectors
Description
Get all instrument sectors or the ones matching the group crtieria
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Query |
group |
Filter result on specified groups |
< string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Sector > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instruments
Get instrument sector
GET /api/2/instruments/sectors/{sector}
Description
Get one or more sector
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
sector |
The sector or sectors to lookup, comma separate multiple inputs |
< string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Sector > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instruments
Get all instrument types
GET /api/2/instruments/types
Description
Get all instrument types. Please note that these types is used for both instrument_type and instrument_group_type.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< InstrumentType > array |
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instruments
Get instrument type
GET /api/2/instruments/types/{instrument_type}
Description
Get info of one orde more instrument type.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
instrument_type |
The instrument type or types to lookup. Comma separate multiple inputs |
< string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< InstrumentType > array |
204 |
No content |
No Content |
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instruments
Get underlyings
GET /api/2/instruments/underlyings/{derivative_type}/{currency}
Description
Get instruments that are underlyings for a specific type of instruments. The query can return instrument that have option derivatives or leverage derivatives. Warrants are included in the leverage derivatives
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
currency |
The currency of the derivative. Please note that the underlying can have a different currency |
string |
Path |
derivative_type |
Chooses which instrument type to find underlyings for |
enum (leverage, option_pair) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Instrument > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instruments
Get trading eligibility
GET /api/2/instruments/validation/suitability/{instrument_id}
Description
Given one or more instrument_id returns trading eligibality for the customer.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
instrument_id |
The instrument id of the instrument to use, comma separate multiple inputs |
< integer(int64) > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< InstrumentEligability > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
Not allowed to access this endpoint with an anonymous session |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instruments
Get instruments
GET /api/2/instruments/{instrument_id}
Description
Get one or more instruments, the instrument id is used as key
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
instrument_id |
The unique instrument id, comma separate multiple inputs |
< integer(int64) > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Instrument > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instruments
Get fund information
GET /api/2/instruments/{instrument_id}/fund/info
Description
Get deeper fund information for one or more funds. If an instrument_id is not a fund it will behave exaclty as if the instrument_id is not existing. This should not be used for lists and such. It is only supposed to be used when displaying everything about an order
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
instrument_id |
The unique instrument id for a fund, comma separate multiple inputs |
< integer(int64) > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< FundInfo > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instruments
Get leverage instruments
GET /api/2/instruments/{instrument_id}/leverages
Description
Returns a list of leverage instruments that have the current instrument as underlying. Leverage instruments is for example warrants and ETF:s. To get all valid filters for the current underlying please use "Get leverages filters". The filters can be used to narrow the search. If "Get leverages filters" is used to fill comboboxes the same filters can be applied on the that call to hide filter cominations that are not valid. Multiple filters can be applied.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
instrument_id |
The instrument id of the underlying instrument |
integer(int64) |
Query |
currency |
Show only leverage instruments with a specific currency |
string |
Query |
expiration_date |
Show only leverage instruments with a specific expiration date |
string(date) |
Query |
instrument_group_type |
Show only instruments with a specific instrument group type |
string |
Query |
instrument_type |
Show only instruments with a specific instrument type |
string |
Query |
issuer_id |
Show only leverage instrumentsm from a specific issuer |
integer(int64) |
Query |
market_view |
Show only leverage instruments with a specific market view |
enum (D, U) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Instrument > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instruments
Get leverage filters
GET /api/2/instruments/{instrument_id}/leverages/filters
Description
Returns valid filter values. Can be used to fill comboboxes in clients to filter leverages results. The same filters can be applied on this request to exclude invalid filter combinations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
instrument_id |
The instrument id of the underlying instrument |
integer(int64) |
Query |
currency |
Show only leverage instruments with a specific currency |
string |
Query |
expiration_date |
Show only leverage instruments with a specific expiration date |
string(date) |
Query |
instrument_group_type |
Show only instruments with a specific instrument group type |
string |
Query |
instrument_type |
Show only instruments with a specific instrument type |
string |
Query |
issuer_id |
Show only leverage instruments from a specific issuer |
integer(int64) |
Query |
market_view |
Show only leverage instruments with a specific market view |
enum (D, U) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instruments
Get option pairs
GET /api/2/instruments/{instrument_id}/option_pairs
Description
Returns a list of call/put option pairs. They are balanced on strike price. In order to find underlyings with options use "Get underlyings". To get available expiration dates use "Get option pair filters"
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
instrument_id |
The instrument id of the underlying instrument |
integer(int64) |
Query |
expiration_date |
Show only option pairs instruments with a specific expiration date |
string(date) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< OptionPair > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instruments
Get option pair filters
GET /api/2/instruments/{instrument_id}/option_pairs/filters
Description
Returns valid filter values. Can be used to fill comboboxes in clients to filter options pair results. The same filters can be applied on this request to exclude invalid filter combinations
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Query |
expiration_date |
Show only leverage instruments with a specific expiration date |
string(date) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instruments
Get todays public trades
GET /api/2/instruments/{instrument_id}/trades
Description
Get all public trades (all trades done on the marketplace) beloning to one ore more instruments.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
instrument_id |
The instrument id of the instrument to use, comma separate multiple inputs |
< integer(int64) > array |
Query |
count |
Number of trades to receive. Integer value or "all". Defaults to 5 |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< InstrumentPublicTrades > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
instruments
Get all instrument lists
GET /api/2/lists
Description
Get all instrument lists.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< List > array |
204 |
No content |
No Content |
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
lists
Get all instruments in a list
GET /api/2/lists/{list_id}
Description
Get all instruments in a list.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
list_id |
The unique id of the list |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Instrument > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
lists
Create session (login)
POST /api/2/login
Description
Before any other of the services (except for the system info request) can be called the user must login. The username, password and phrase must be sent encrypted.
Three steps is required:
1. First Base64-encode the username, password and timestamp (UNIX timestamp in milliseconds) and combine them with the character ':'
2. Use the public key for the application and encrypt the string
3. Base64 encode the encrypted string.
Note
: The public key is unique for the service type and can only be used together with the service. The name of the service and the public key is provided by Nordnet.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
FormData |
auth |
The authorization blob created above. |
string |
FormData |
service |
The service name (provided by Nordnet). |
string |
FormData |
session_lang |
The default prefered language of the session, the header "Accept-Language" overrides the session language. Please note that if the session fails to create the language will not be set so in order to get an error message on the login in the correct lang the header 'Accept-Language' must also be set. Valid values: sv, da, fi, en, no, nb, nn. Note: nb and nn will return the same as no. If not set en is used |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
400 |
Invalid parameter |
|
401 |
Not allowed to login with the credentials |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
login
Touch session
PUT /api/2/login
Description
If the application needs to keep the session alive the session can be touched. Note the basic authorization header field must be set as for all other calls. All calls to any REST service is touching the session. So touching the session manually is only needed if no other calls are done during the session timeout interval.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
login
Delete session (logout)
DELETE /api/2/login
Description
Invalidates the session.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
login
Get all markets
GET /api/2/markets
Description
Get all tradable markets. Market 80 is the smart order market. Instruments that can be traded on 2 or more markets gets a tradable on the smart order market. Orders entered with the smart order tradable get smart order routed with the current Nordnet best execution policy. The policy <a href="https://www.nordnet.se/pdf/se/riktlinjer.pdf">Riktlinjer för utförande av order (Swedish)</a>.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Market > array |
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
markets
Get market
GET /api/2/markets/{market_id}
Description
Lookup one or more markets by market_id. Multiple market can be queried at the same time by comma separating the market_ids. Market 80 is the smart order market. Instruments that can be traded on 2 or more markets gets a tradable on the smart order market. Orders entered with the smart order tradable get smart order routed with the current Nordnet best execution policy. The policy <a href="https://www.nordnet.se/pdf/se/riktlinjer.pdf">Riktlinjer för utförande av order (Swedish)</a>.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
market_id |
The market id to lookup. Comma separate multiple inputs |
< integer(int64) > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< Market > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
markets
Delete messages
DELETE /api/2/messages
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
FormData |
message_ids |
messages to delete |
< integer(int64) > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
No Content |
204 |
No content |
No Content |
401 |
Invalid session |
|
404 |
Not Found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
messages
News search
GET /api/2/news
Description
Search for news. If no search field is used the last articles available to the user is returned
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
days |
How far back in time the search should be done. 0 means today. If empty all news is searched and the response is limited by the limit |
integer(int64) |
|
Query |
excluded_news_types |
NEWS_TYPES to exclude. Empty list excludes none. Can not be combined with includedNewsTypes (see NewsPreview model for available NEWS_TYPES) |
< string > array |
|
Query |
included_news_types |
NEWS_TYPES to include. Empty list includes all. Can not be combined with excludedNewsTypes (see NewsPreview model for available NEWS_TYPES) |
< string > array |
|
Query |
instrument_id |
Only news belonging to the given instrument_id is returned. Comma separate multiple inputs, if empty news for all instruments is returned |
< integer(int32) > array |
|
Query |
limit |
Max number of items in the reply. Max value is 100. Default is 100. If more news items is required multiple requests with offset should be done |
integer(int64) |
|
Query |
market_id |
Filter news on market_id, comma separate multiple markets |
< integer(int32) > array |
|
Query |
news_lang |
Filter news on language (sv, en and so on), comma separate multiple languages |
< string > array |
|
Query |
offset |
Used together with limit to create pagination. This is the first news item to show. Defaults to 0 |
integer(int64) |
|
Query |
query |
The search string. If not given all news items in the interval is returned (the result can be truncated by count) |
string |
|
Query |
sort_order |
'asc' or 'desc'. Defining the sort order of the result set. The result is sorted on timestamp. Defaults to 'desc' |
string |
|
Query |
source_id |
Specify one or more sources to use, separate with comma. If empty all available sources is used. |
< integer > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< NewsPreview > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
news
Get Daily Calendar for User’s default Country
GET /api/2/news/calendar/daily
Description
Show the daily calendar for Country defined in User’s session
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Query |
body_format |
Format to use for the body text. Currently 'plain' (default) or 'markdown' are available |
string |
Query |
date |
The date (YYYYMMDD) to get Daily Calendar for, defaults to today |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
news
Get Daily Calendar for Country
GET /api/2/news/calendar/daily/{country}
Description
Show the daily calendar for specified Country
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
country |
Country for which to get Daily Calendar |
enum (SE, NO, DK, FI) |
Query |
body_format |
Format to use for the body text. Currently 'plain' (default) or 'markdown' are available |
enum (plain, markdown) |
Query |
date |
The date (YYYYMMDD) to get Daily Calendar for, defaults to today |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
news
Return the most accessed news articles at Nordnet
GET /api/2/news/most_read
Description
Will only take in account fully news articles (not previews) loaded via nnapi or directly via service-news-search
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
days |
How far back in time the search should be done. 0 means today. (Min: 0, Max: 365, Default: 0) |
integer(int32) |
|
Query |
limit |
Max number of items in the reply. Max value is 100. Default is 100. If more news items is required multiple requests with offset should be done |
integer(int32) |
|
Query |
min_reads |
How many reads must articles have to qualify for this query (Min: 1, Default: 5) |
integer(int32) |
|
Query |
news_lang |
Filter news on language (sv, en and so on), comma separate multiple languages |
< string > array |
|
Query |
offset |
Used together with limit to create pagination. This is the first news item to show. Defaults to 0 |
integer(int32) |
|
Query |
source_id |
Specify one or more sources to use, separate with comma. If empty all available sources is used |
< integer > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< NewsPreview > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
news
News Top stories from DIREKT
GET /api/2/news/topstories/direkt
Description
Get the latest top stories. (Currently only DIREKT news agency, sourceId = 1, supported)
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< NewsPreview > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
news
Get news item
GET /api/2/news/{item_id}
Description
Show one or more news items.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
item_id |
The news item to lookup. Comma separate multiple lookups |
< integer(int64) > array |
Query |
body_format |
Format to use for the body text. Currently 'plain' (default) or 'markdown' are available |
enum (plain, markdown) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< NewsArticle > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
news
Get news sources
GET /api/2/news_sources
Description
Returns a list of news sources the user has access to
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< NewsSource > array |
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
news_sources
Adds an instrument alarm
POST /api/2/price_alarms/alarms
Description
Creates an alarm
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Body |
body |
Needed info when creating an alarm |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Instrument alarm added successfully |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
|
500 |
Wrong input data |
Produces
-
application/json
Tags
-
price_alarms
Get all configured alarms for a customer
GET /api/2/price_alarms/alarms
Description
Get a list with all configured alarms
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
limit |
Max number of results to return per display group |
integer(int32) |
|
Query |
offset |
Offset for pagination |
integer(int32) |
|
Query |
sort_field |
Set which field to sort by. |
enum (INSTRUMENT_NAME, TERMS, ACTIVATION_PRICE, LAST_PRICE) |
|
Query |
sort_order |
Sorting order. |
enum (ASC, DESC) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No content |
No Content |
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
price_alarms
Get all triggered alarms for a customer
GET /api/2/price_alarms/alarms/history
Description
Get a list with all triggered alarms
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Query |
limit |
Max number of results to return per display group |
integer(int32) |
|
Query |
offset |
Offset for pagination |
integer(int32) |
|
Query |
period |
Period for the returned triggered alarms. |
enum (D1, W1, M1, ALL) |
|
Query |
sort_field |
Set which field to sort by. |
enum (INSTRUMENT_NAME, TERMS, ACTIVATION_PRICE, ACTIVATED_AT) |
|
Query |
sort_order |
Sorting order. |
enum (ASC, DESC) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
204 |
No content |
No Content |
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
price_alarms
Get all triggered alarms for an instrument id
GET /api/2/price_alarms/alarms/history/instrument/{instrument_id}
Description
Get a list with all triggered alarms for an instrument id
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
|
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
|
Path |
instrument_id |
instrument id |
integer(int64) |
|
Query |
limit |
Max number of results to return per display group |
integer(int32) |
|
Query |
offset |
Offset for pagination |
integer(int32) |
|
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
< TriggeredAlarmsResult > array |
204 |
No content |
No Content |
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
price_alarms
Get all configured alarms for an instrument ID
GET /api/2/price_alarms/alarms/instrument/{instrument_id}
Description
Get a list with all configured alarms for a provided instrument ID
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
instrument_id |
Instrument ID |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Invalid session |
|
404 |
Instrument alarm not found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
|
500 |
Internal server error |
Produces
-
application/json
Tags
-
price_alarms
Count all configured alarms for an instrument ID
GET /api/2/price_alarms/alarms/instrument/{instrument_id}/count
Description
Count a list with all configured alarms for a provided instrument ID
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
instrument_id |
Instrument ID |
integer(int64) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
OK |
|
401 |
Invalid session |
|
404 |
Instrument alarm not found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
|
500 |
Internal server error |
Produces
-
application/json
Tags
-
price_alarms
Get an instrument alarm
GET /api/2/price_alarms/alarms/{alarm_id}
Description
Get an instrument alarm for an instrument_id
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
alarm_id |
Alarm ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Instrument alarm returned successfully |
|
400 |
Invalid parameter |
|
401 |
Invalid session |
|
404 |
Instrument alarm not found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
|
500 |
Internal server error |
Produces
-
application/json
Tags
-
price_alarms
Updates an instrument alarm
PUT /api/2/price_alarms/alarms/{alarm_id}
Description
Updates an instrument alarm according to the request body
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
alarm_id |
Alarm ID |
string |
Body |
body |
Request body |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Instrument alarm updated successfully |
|
204 |
No content |
No Content |
401 |
Invalid session |
|
404 |
Instrument alarm not found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
|
500 |
Internal server error |
Produces
-
application/json
Tags
-
price_alarms
Delete an instrument alarm
DELETE /api/2/price_alarms/alarms/{alarm_id}
Description
Deletes alarm with alarm_id
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
alarm_id |
Alarm ID |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
Instrument alarm deleted successfully |
|
204 |
No content |
No Content |
401 |
Invalid session |
|
404 |
Instrument alarm not found |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
price_alarms
Get realtime access
GET /api/2/realtime_access
Description
Get realtime data access. This applies to the access on the feeds. If the market is missing the user don’t have realtime access on that market
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< RealtimeAccess > array |
204 |
No content |
No Content |
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
realtime_access
Get approved mifid 2 categories for a user
GET /api/2/suitability
Description
Get a list of integers representing all mifid2 categories that a user is approved to trade
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
suitability
Get all ticksize tables
GET /api/2/tick_sizes
Description
Get all ticksize tables.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< TicksizeTable > array |
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
tick_sizes
Get ticksize tables
GET /api/2/tick_sizes/{tick_size_id}
Description
Get one or more ticksize tables.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
tick_size_id |
The ticksize table to lookup. |
< integer(int64) > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< TicksizeTable > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
tick_sizes
Get tradable info
GET /api/2/tradables/info/{tradables}
Description
Get trading calender and allowed trading types for one or more tradable.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
tradables |
[market_id]:[identifier] of the tradable. Example 11:101 for ERIC B, comma separate multiple inputs |
< string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< TradableInfo > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
tradables
Get intraday prices
GET /api/2/tradables/intraday/{tradables}
Description
Can be used for populating instrument price graphs for today. Resolution is one minute
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
tradables |
[market_id]:[identifier] of the tradable. Example 11:101 for ERIC B, comma separate multiple inputs |
< string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< IntradayGraph > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
tradables
Get todays public trades
GET /api/2/tradables/trades/{tradables}
Description
Get all public trades (all trades done on the marketplace) beloning to one ore more tradable.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
tradables |
[market_id]:[identifier] of the tradable. Example 11:101 for ERIC B, comma separate multiple inputs |
< string > array |
Query |
count |
Number of trades to receive. Integer value or "all". Defaults to 5 |
string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< TradablePublicTrades > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
tradables
Get trading eligibality
GET /api/2/tradables/validation/suitability/{tradables}
Description
Given one or more tradable returns trading eligibality for the customer.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
Header |
Accept-Language |
Language preferred in the response. Overrides the session lang. Note: nb and nn will return the same as no |
enum (en, sv, fi, da, no, nb, nn) |
Header |
Authorization |
Basic authorization. The session_id should be sent as both username and password |
string |
Path |
tradables |
[market_id]:[identifier] of the tradable. Example 11:101 for ERIC B, comma separate multiple inputs |
< string > array |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
200 |
No response was specified |
< TradableEligability > array |
204 |
No content |
No Content |
400 |
Invalid parameter |
|
401 |
Invalid session |
|
403 |
Not allowed to access this endpoint with an anonymous session |
No Content |
429 |
Too Many Requests, please wait for 10 seconds before trying again |
Produces
-
application/json
Tags
-
tradables
Definitions
Account
| Name | Description | Schema |
|---|---|---|
accid |
The account id of the account. The id is unique within the session. Please note that the accid can be different when the same user logs in again. Do not persist this information and use it different sessions. Not applicable for partners |
integer(int64) |
accno |
The Nordnet account number |
integer(int64) |
alias |
Account alias can be set on Nordnet Web by the end user |
string |
atyid |
Account type identifier |
integer(int32) |
blocked_reason |
Description to why the account is blocked. The language specified in the request is used in this reply so it can be displayed to the end user |
string |
default |
True if this is the default account |
boolean |
is_blocked |
True if the account is blocked. No queries can be made to this account |
boolean |
shareville_alias |
Shareville alias that is connected to this accno. Only available for certain systems |
string |
type |
Translated account type. Can be displayed for the end user |
string |
AccountInfo
| Name | Description | Schema |
|---|---|---|
accid |
The account id of the account. The id is unique within the session. Please note that the accid can be different when the same user logs in again. Do not persist this information and use it different sessions. Not applicable for partners |
integer(int64) |
accno |
The Nordnet account number |
integer(int64) |
account_credit |
Account credit |
|
account_currency |
The account currency |
string |
account_sum |
All ledgers combined |
|
bonus_cash |
Bonus cash if available |
|
collateral |
Collateral claim for options |
|
credit_account_interest |
Accrued interest for credit account if available |
|
credit_account_sum |
Sum for credit account if available |
|
forward_sum |
Locked amount for forwards |
|
full_marketvalue |
Total market value |
|
future_sum |
Not realized profit/loss for future |
|
interest |
Interest on the account |
|
intraday_credit |
Intraday credit if available |
|
loan_limit |
Max loan limit (regardless of pawnvalue) |
|
own_capital |
account_sum + full_marketvalue + interest + forward_sum + future_sum + unrealized_future_profit_loss |
|
own_capital_morning |
Own capital calculated in the morning. Static during the day |
|
pawn_value |
Pawn value of all positions combined |
|
registration_date |
Registration date of the account in YYYY-MM-DD format |
string(date) |
trading_power |
Available for trading |
|
unrealized_future_profit_loss |
Unrealized profit and loss for futures |
ActivationCondition
| Name | Description | Schema |
|---|---|---|
trailing_value |
Only used when type is STOP_ACTPRICE_PERC. This is the fix point that the trigger_value and target_value percent is calculated from |
number(double) |
trigger_condition |
The comparison that should be used on trigger_value <= or >| |
string |
trigger_value |
If type is STOP_ACTPRICE_PERC the value is the given in percent. If type is STOP_ACTPRICE the value is a fixed price |
number(double) |
type |
Stop loss activation condition. NONE - This order has no activation condition. It is sent directly to the market (if the market is open) MANUAL - The order is inactive in the Nordnet system and is activated by the user STOP_ACTPRICE_PERC - Trailing stop loss. The order is activated when the price changes by percent STOP_ACTPRICE - The order is activated when the market price of the instrument reaches a trigger price |
string |
AlarmResponse
| Name | Description | Schema |
|---|---|---|
active_notification_types |
These platforms will get notifications. Valid types are {"EMAIL", "MOBILE", "SMS", "WEB"} |
< string > array |
alarm_id |
The alarmId |
string |
close_price |
Close price |
number(double) |
currency |
Currency code |
string |
direction |
Direction |
string |
exchange_country |
Country code |
string |
identifier |
Identifier |
integer(int32) |
instrument_group_type |
The intrument group type |
string |
instrument_id |
The Nordnet instrument id |
integer(int32) |
instrument_type |
The intrument type |
string |
last_price |
Last price |
number(double) |
last_price_timestamp |
The timestamp of the last price |
integer(int64) |
market_id |
The market ID |
integer(int32) |
name |
Name of the instrument |
string |
realtime |
Is price updated in realtime |
boolean |
snapshot_price |
The snapshot price |
number(double) |
snapshot_timestamp |
The snapshot timestamp |
integer(int64) |
symbol |
Symbol |
string |
trigger_level |
Trigger level |
number(double) |
update_timestamp |
The update timestamp |
integer(int64) |
AllocationList
| Name | Description | Schema |
|---|---|---|
category |
Category |
string |
weight |
Weight |
integer(int32) |
AllocationsBody
| Name | Description | Schema |
|---|---|---|
category |
The fund category |
string |
weight |
Percentage investment in this allocation group |
integer(int32) |
Amount
Value/currency combo for amount in a specific currency
| Name | Description | Schema |
|---|---|---|
currency |
The amount currency |
string |
value |
The amount value |
number(double) |
AnnualGrowthInfo
| Name | Description | Schema |
|---|---|---|
annual_growth_10y |
Growth 10 year |
number |
annual_growth_1y |
Growth 1 year |
number |
annual_growth_2y |
Growth 2 year |
number |
annual_growth_3y |
Growth 3 year |
number |
annual_growth_5y |
Growth 5 year |
number |
AnswersBody
| Name | Description | Schema |
|---|---|---|
image_description |
Image description |
string |
image_link |
Link to image |
string |
value |
Value |
string |
ArchiveMessagesCount
| Name | Description | Schema |
|---|---|---|
count |
The count of archive messages |
integer(int32) |
AttributeResult
| Name | Description | Schema |
|---|---|---|
filter_details |
Additional details for attributes with filterable=true |
|
filterable |
Can the attribute be provided as a filter in /search and /attribute endpoints |
boolean |
id |
The attribute id |
string |
name |
The name of the attribute |
string |
returnable |
Can the attribute be returned in /search endpoints |
boolean |
sortable |
Can the attribute be used for sorting in /search endpoints |
boolean |
AttributeResults
| Name | Description | Schema |
|---|---|---|
attributes |
List of attributes |
< AttributeResult > array |
attributes_count |
Number of attributes in this response |
integer(int64) |
BullBearEntity
| Name | Description | Schema |
|---|---|---|
certificate_info |
Certificates information |
|
etp_info |
ETP information |
|
exchange_info |
Information regarding the instrument/tradable on the exchange |
|
instrument_info |
Instrument information. The same instrument info may appear in multiple search results if there are multiple tradables or fund universes. |
|
market_info |
Market information, identifies which market the price info is collected from |
|
price_info |
Price information, representing an exchange traded model containing top-of-book info |
BullBearListResults
| Name | Description | Schema |
|---|---|---|
results |
The search results |
< BullBearEntity > array |
rows |
Number of result rows returned |
integer(int32) |
total_hits |
Total number of search hits |
integer(int64) |
underlying_instrument_id |
Id of the underlying instrument if and only if the results contains instruments with the same underlying instrument |
integer(int64) |
CalendarDay
| Name | Description | Schema |
|---|---|---|
close |
The close time in UNIX timestamp (UTC) in milliseconds |
integer(int64) |
date |
The date on the format YYYY-MM-DD |
string(date) |
open |
The open time in UNIX timestamp (UTC) in milliseconds |
integer(int64) |
CertificateInfo
| Name | Description | Schema |
|---|---|---|
static_high_risk |
High risk |
boolean |
static_leverage |
Static leverage |
number(double) |
ChargeGroup
| Name | Description | Schema |
|---|---|---|
charge_group_id |
The ChargeGroupId of the account |
integer(int32) |
has_pending_change |
True if the customer has pending charge group change |
boolean |
tag |
Translation tag for given charge group |
string |
ChargeGroupDefinitionIndex
| Name | Description | Schema |
|---|---|---|
international_minimum |
Minimum commission paid for trades on non-Nordic markets |
|
international_percentage_fee |
Commission cost in percentage paid for trades on non-Nordic markets. Expressed in decimal format (10% -> 0.1) |
number(float) |
nordic_minimum |
Commission paid for trades on the Nordic markets |
|
nordic_percentage_fee |
Commission in percentage paid for trades on the Nordic markets. Expressed in decimal format (10% -> 0.1) |
number(float) |
usage_maximum |
Maximum recommended trade size for this charge group |
|
usage_minimum |
Minimum recommended trade size for this charge group |
ChargeGroupIndex
| Name | Description | Schema |
|---|---|---|
charge_group_definition |
Expresses what it means to have a given charge group |
|
charge_group_id |
The ChargeGroupId of the account |
integer(int32) |
tag |
Translation tag for given charge group |
string |
ChargeGroups
| Name | Description | Schema |
|---|---|---|
charge_groups |
List of charge groups that a accounts is allowed to have. May be empty |
< ChargeGroupIndex > array |
ChargeSpecification
| Name | Description | Schema |
|---|---|---|
fraction |
Fee in fraction of whole investment |
number(float) |
CompanyDataCompany
| Name | Description | Schema |
|---|---|---|
ceo |
ceo |
string |
company_id |
company_id |
integer(int64) |
description |
description |
string |
email |
string |
|
employees |
employees |
integer(int64) |
headquarter |
headquarter |
string |
industry |
industry |
string |
industry_group |
industry_group |
string |
market_cap |
The market cap for this company all equities |
number |
name |
name |
string |
sector |
sector |
string |
url |
url |
string |
CompanyDataCorporatecalendar
| Name | Description | Schema |
|---|---|---|
date |
Date for event |
string |
event_description |
The type, expressed in local language (if available and 'Accept-Language' provided) |
string |
event_type |
The type of event, expressed in predefined event types |
enum (GENERAL_MEETING, BOARD_MEETING, DIVIDEND_N_STOCK_SPLIT_ANNOUNCEMENT, FIRST_QUARTER_EARNINGS_RESULTS, SECOND_QUARTER_EARNINGS_RESULTS, THIRD_QUARTER_EARNINGS_RESULTS, FOURTH_QUARTER_EARNINGS_RESULTS, ANNUAL_REPORT) |
CompanyDataDividends
| Name | Description | Schema |
|---|---|---|
amount_paid |
Amount paid |
number |
currency |
The currency used for dividend |
string |
excluding_date |
The X date |
string |
pay_date |
The date the dividend is payed |
string |
CompanyDataEquity
| Name | Description | Schema |
|---|---|---|
currency |
Currency the equity is traded in |
string |
introduction_date |
Date when the stock was listed |
string |
isin_code |
ISIN code of the equity |
string |
number_of_shares |
The number of shares for this equity |
integer(int64) |
CompanyDataFinancialValues
| Name | Description | Schema |
|---|---|---|
category |
Financial category |
string |
group |
Financial group |
enum (BALANCE_SHEET, CASH_FLOW, INCOME_STATEMENT) |
year_values |
The value for each year |
< number > array |
CompanyDataKeyFigures
| Name | Description | Schema |
|---|---|---|
dividend_per_share |
dividend_per_share |
number |
earnings_per_share |
earnings_per_share |
number |
forward_dividend_yield |
forward_dividend_yield |
number |
forward_dividends_per_share |
forward_dividends_per_share |
number |
forward_peratio |
forward_peratio |
number |
one_year_estimated_eps_growth |
one_year_estimated_eps_growth |
number |
peg_ratio |
peg_ratio |
number |
price_bookings |
price_bookings |
number |
price_earnings |
price_earnings |
number |
price_sales |
price_sales |
number |
CompanyDataSummary
| Name | Description | Schema |
|---|---|---|
company |
Holds company specific data |
|
equity |
Holds equity specific data |
|
instrument_id |
Unique identifier of instrument connected to the company |
integer(int64) |
CompanyDataYearlyFinancial
| Name | Description | Schema |
|---|---|---|
currency |
currency |
string |
currency_prefix |
currency_prefix |
enum (K, M, NONE) |
data |
Financial details |
< CompanyDataFinancialValues > array |
years |
Years for which financials apply |
< string > array |
ContinuousDeposit
| Name | Description | Schema |
|---|---|---|
deposit |
Amount to be added |
|
interval |
Interval unit. Possible values ['MONTHS', 'YEARLY'] |
string |
CountResponse
| Name | Description | Schema |
|---|---|---|
count |
Number of alarms for Instrument ID |
integer(int32) |
instrument_id |
The Nordnet instrument id |
integer(int32) |
Country
| Name | Description | Schema |
|---|---|---|
country |
The country code |
string |
name |
The translated name of the country |
string |
CreateInstrumentAlarmSpec
| Name | Description | Schema |
|---|---|---|
active_notificationTypes |
These platforms will get notifications. Valid types are {"EMAIL", "MOBILE", "SMS", "WEB"} |
< string > array |
alarm_type |
The alarm type |
string |
direction |
The direction of the price when passing the trigger level |
string |
expiration_timestamp |
The expiration timestamp |
integer(int64) |
instrument_id |
Intrument ID |
integer(int64) |
repeat_type |
Setting for repetition of alarm |
string |
snapshot_price |
The snapshot price |
number(double) |
snapshot_timestamp |
The snapshot timestamp |
integer(int64) |
trigger_level |
The level on whcih an alarm should trigger |
number(double) |
CreateResponse
| Name | Description | Schema |
|---|---|---|
message_id |
The id of the created message |
integer(int32) |
CustomCharge
| Name | Description | Schema |
|---|---|---|
calculation_interval |
Interval at which the fee should be calculated. Possible values ['DAILY'] |
string |
charge_family |
Type of charge. Possible values ['ONGOING'] |
string |
charge_specification |
Charge specification |
|
payment_interval |
Interval at which the charge should be deducted from the investment |
string |
DerivativeInfo
| Name | Description | Schema |
|---|---|---|
contract_multiplier |
The contract multiplier of the derivative |
integer(int32) |
expire_date |
The expire date for the derivative in Epoch time |
integer(int64) |
start_date |
The start date for the derivative in Epoch time |
integer(int64) |
DiffWithDecimals
| Name | Description | Schema |
|---|---|---|
decimals |
Number of decimals |
integer(int32) |
diff |
The diff |
number(double) |
ErrorField
Description of fields with errors
| Name | Description | Schema |
|---|---|---|
code |
Error code |
string |
field |
The field name with the error |
string |
message |
Error message |
string |
ErrorResponse
Standard error description
| Name | Description | Schema |
|---|---|---|
code |
The error code |
string |
message |
A human readable error if available. This message is translated. |
string |
EtpInfo
| Name | Description | Schema |
|---|---|---|
direction |
The direction of a certificate, translated to user’s language |
string |
nordnet_markets |
If the instrument is part of Nordnet Markets |
boolean |
underlying_instrument_id |
The id of the underlying instrument |
integer(int64) |
underlying_name |
The short name of the underlying instrument |
string |
ExchangeInfo
| Name | Description | Schema |
|---|---|---|
exchange_country |
Which country is the instrument traded in |
string |
ExtendedErrorResponse
Extended error description
| Name | Description | Schema |
|---|---|---|
code |
The error code |
string |
fields |
Fields with errors |
< ErrorField > array |
message |
A human readable error if available. This message is translated. |
string |
FakCharge
| Name | Description | Schema |
|---|---|---|
amount |
How much the charge was |
|
fraction_of_total |
This charge as a fraction of market value |
number(float) |
Fee
| Name | Description | Schema |
|---|---|---|
amount |
Amount that will be charged from the account |
|
description |
Fee description |
string |
due_date |
Due date in YYYY-mm-dd format |
string(date) |
status |
Current status of the fee |
string |
Feed
| Name | Description | Schema |
|---|---|---|
encrypted |
True if the feed is encrypted |
boolean |
hostname |
The feed hostname |
string |
port |
The feed port |
integer(int64) |
FeesAndRefundsSummary
| Name | Description | Schema |
|---|---|---|
fees |
List of fees |
< Fee > array |
refund |
Sum of all the refunds for the account |
FilterDetails
| Name | Description | Schema |
|---|---|---|
attribute |
The attribute id |
string |
parent_filters |
List of attribute ids which are logical parent filters for this attribute. (E.g. market_id is a parent of market_sub_id.) |
< string > array |
requires_expand |
When requires_expand=true, the attribute id must be provided to /attributes endpoints via expand if filter values should be returned. |
boolean |
values |
List of filter values for this attribute, if expand is specified. Only supports MULTISELECT filter type for now. |
< FilterVal > array |
FilterVal
| Name | Description | Schema |
|---|---|---|
count |
The number of instruments/tradables which have this filter id, given provided applyFilters |
integer(int64) |
id |
The attribute filter id |
string |
name |
The attribute filter display name, possibly translated |
string |
FundAdminInfo
| Name | Description | Schema |
|---|---|---|
address1 |
Admin company address |
string |
address2 |
Admin company address |
string |
address3 |
Admin company address |
string |
branding_company_name |
Branding company name |
string |
city |
The city of the admin company |
string |
country |
Country of the admin company. This is the address country in the language the fund company decided not the country code. Only for display |
string |
name |
Admin company name |
string |
phone_number |
Phone number to the admin company |
string |
ppm_code |
Code used by PremiePensionsMyndigheten |
string |
url |
URL to the admin company |
string |
zip_code |
Zip code of the admin company |
string |
FundAllocationInfo
| Name | Description | Schema |
|---|---|---|
type |
The identifier name of this holding in the user’s language. For display purposes |
string |
type_id |
The identifier type |
string |
weight |
Weight percentage of this holding |
number(float) |
FundFeeInfo
| Name | Description | Schema |
|---|---|---|
aop |
AOP is a cost figure which all Danish funds have to calculate and combines all expenses related to investing in a mutual fund. Including TER, purchase fees, selling fees and brokerage costs. This value is forward looking. AOP stands for Arlige Omkostninger i Procent |
number(float) |
buy_fee |
The buy fee |
number(float) |
calculated_fee |
Calculated fee for Norway |
number(float) |
defer_load |
Indlosningsfradrag for Danish investment funds |
number(float) |
front_load |
Emissionstillag for Danish investment funds |
number(float) |
indirect_cost |
The amount charged for indirect expenses (Indirekte handelsomkostninger) not included in the Danish Total Cost Figure (AOP - Arlige Omkostninger i Procent). The charge covers implicit expenses such as spreads, market impact, currency conversion etc |
number(float) |
max_management_fee |
Max Management fee |
number(float) |
ongoing_charge |
The ongoing charge represents the costs you can reasonably expect to pay as an investor from one year to the next, under normal circumstances |
number(float) |
performance_fee |
Performance fee |
number(float) |
platform_fee |
Platform fee for Norway |
number(float) |
refunding |
Refunding fee for Norway |
number(float) |
sell_fee |
The sell fee |
number(float) |
FundGuidanceCategoryResponse
| Name | Description | Schema |
|---|---|---|
category |
The fund category |
string |
instruments |
The fund details |
< FundGuidanceInstrumentResponse > array |
weight |
Percentage investment in this allocation group |
integer(int32) |
FundGuidanceInstrumentResponse
| Name | Description | Schema |
|---|---|---|
amount |
Proximity value of amount to be invested |
number(double) |
clearing_place |
Same as clearing_place in service-instrument |
string |
currency |
Same as currency in service-instrument |
string |
display_name |
Name |
string |
fund_min_investment |
Minimum investment amount in user’s local currency |
integer(int32) |
fund_ms_rating |
The morningstar rating |
integer(int32) |
fund_yearly_fee |
Fund yearly fee |
number(float) |
instrument_group_type |
Same as instrument_group_type in service-instrument |
string |
instrument_id |
Same as instrument_id in service-instrument |
integer(int64) |
instrument_type |
Same as instrument_type in service-instrument |
string |
is_low_carbon |
Shows if fund deals in low carbon instruments |
boolean |
isin |
Same as isin_code in service-instrument |
string |
name |
A short name intended for presentation |
string |
price_info |
Current NAV (or last price for exchange traded instruments) |
|
prospectus_url |
The URL for the prospectus |
string |
quantity |
Number of shares to be traded (Only applicable for excahnge traded instruments) |
integer(int32) |
weight |
Percentage investment in this instrument |
integer(int32) |
yield_10y |
Yield 10 years, diff in price between 'now' and 10 years ago |
number(double) |
yield_1y |
Yield 1 year, diff in price between 'now' and last year |
number(double) |
yield_3y |
Yield 3 years, diff in price between 'now' and 3 years ago |
number(double) |
yield_5y |
Yield 5 years, diff in price between 'now' and 5 years ago |
number(double) |
FundGuidancePortfolios
| Name | Description | Schema |
|---|---|---|
matched_risk |
Matched Risk |
string |
portfolio_list |
The portfolio list |
< PortfolioBody > array |
FundGuidanceQuestions
| Name | Description | Schema |
|---|---|---|
fund_selection |
Fund selection |
|
investment_objective |
Investment Objective |
|
time_and_risk |
Time and risk |
FundGuidanceRequestBody
| Name | Description | Schema |
|---|---|---|
allocations |
Allocation with percentage |
< AllocationsBody > array |
fund_filter_categories |
Filters to find right funds |
< string > array |
fund_instrument_type |
What type of funds to return |
enum (FUND, PINV, ETF) |
investment_amount |
Investment amount in user’s local currency |
integer(int32) |
investment_objective |
Objective for saving |
string |
periodically |
Period |
string |
FundInfo
| Name | Description | Schema |
|---|---|---|
admin_info |
The admin company |
|
asset_allocation |
Information about asset allocation |
< FundAllocationInfo > array |
description |
Description of the fund. Please note that the language of this field is decided by the fund admin company and not controlled by the lang in the api |
string |
extended_regional_allocation |
Information about extended regional allocation |
< FundAllocationInfo > array |
fees |
Information about fund fees |
|
inception_date |
The start date of the fund |
string(date) |
instrument_id |
Unique identifier of the instrument. |
integer(int64) |
instrument_underlying_info |
Information about underlying instruments |
< InstrumentUnderlyingInfo > array |
is_index_fund |
If is index fund |
boolean |
manager_info |
The manager |
< FundManagerInfo > array |
min_investment |
The minimum amount allowed to invest |
|
morningstar_info |
Morningstar info about the fund |
|
product_involvement |
Percentage involvement per area |
|
regional_allocation |
Information about regional allocation |
< FundAllocationInfo > array |
risk_statistics |
Risk statistics per one, three and five years |
|
sector_allocation |
Information about section allocation |
< FundAllocationInfo > array |
sustainability |
Sustainability ratings along with category average |
|
trading_info |
Trading status of the fund |
FundInstruments
| Name | Description | Schema |
|---|---|---|
clearing_place |
Same as clearing_place in service-instrument |
string |
currency |
Same as currency in service-instrument |
string |
display_name |
Name |
string |
fund_min_investment |
Minimum investment amount in user’s local currency |
integer(int32) |
fund_ms_rating |
The morningstar rating |
integer(int32) |
fund_yearly_fee |
Fund yearly fee |
number(float) |
instrument_group_type |
Same as instrument_group_type in service-instrument |
string |
instrument_id |
Same as instrument_id in service-instrument |
integer(int64) |
instrument_type |
Same as instrument_type in service-instrument |
string |
is_low_carbon |
Shows if fund deals in low carbon instruments |
boolean |
isin |
Same as isin_code in service-instrument |
string |
name |
A short name intended for presentation |
string |
prospectus_url |
The URL for the prospectus |
string |
yield_10y |
Yield 10 years, diff in price between 'now' and 10 years ago |
number(double) |
yield_1y |
Yield 1 year, diff in price between 'now' and last year |
number(double) |
yield_3y |
Yield 3 years, diff in price between 'now' and 3 years ago |
number(double) |
yield_5y |
Yield 5 years, diff in price between 'now' and 5 years ago |
number(double) |
FundManagerInfo
| Name | Description | Schema |
|---|---|---|
bio |
The bio of the manager |
string |
name |
The name of the managers |
string |
start_date |
The date when the manager was appointed |
string(date) |
FundMessage
| Name | Description | Schema |
|---|---|---|
code |
The response code |
string |
message |
The actual translated message to display to the end user |
string |
FundOrder
| Name | Description | Schema |
|---|---|---|
accno |
The Nordnet account number |
integer(int64) |
amount |
The amount to buy for. Only displayed for buy orders |
|
instrument |
The fund instrument |
|
is_active |
True if the order is active (should in normal case always be true) |
boolean |
modified |
The timestamp when modified |
integer(int64) |
order_id |
Fund order id. Please note that a fund order can have the same order id as an ordinary order. |
integer(int64) |
send_error |
If true the order could not be sent to the market |
boolean |
sent |
If true the order is sent and cannot be deleted |
boolean |
side |
BUY or SELL |
string |
volume |
The volume of the order. Only displayed for sell orders |
number(double) |
FundOrderDeleteReply
| Name | Description | Schema |
|---|---|---|
is_success |
Indicates if the order delete was a success |
boolean |
message |
Response messages for displaying to the end user |
string |
FundOrderReply
| Name | Description | Schema |
|---|---|---|
is_success |
Indicates if the order entry was a success |
boolean |
message |
Response message for displaying to the end user |
|
order_expiration |
Time when the order is expired, only displayed for some systems |
integer(int64) |
reference_id |
Order reference id, only displayed for some systems |
string |
FundSearchEntity
| Name | Description | Schema |
|---|---|---|
annual_growth_info |
Annual growth. |
|
fundlist_info |
Contains funds specific information. |
|
historical_returns_info |
Historical returns information, showing the yield over time |
|
instrument_info |
Instrument information. The same instrument info may appear in multiple search results if there are multiple tradables or funds universes. |
|
market_info |
Market information, identifies which market the price info is collected from |
|
price_info |
Price information, representing an exchange traded model containing top-of-book info |
FundSearchResults
| Name | Description | Schema |
|---|---|---|
results |
The search results |
< FundSearchEntity > array |
rows |
Number of result rows returned |
integer(int32) |
total_hits |
Total number of search hits |
integer(int64) |
FundSelection
| Name | Description | Schema |
|---|---|---|
fund_selection_question |
Fund selection question |
FundSelectionQuestion
| Name | Description | Schema |
|---|---|---|
answers |
Anwers |
< AnswersBody > array |
multiple_answer |
Multiple answers |
boolean |
FundTradingInfo
| Name | Description | Schema |
|---|---|---|
cut_off_time |
The time of day where the funds orders are sent |
string |
dividend_strategy |
Dividend strategy expressed with keyword |
string |
is_active_buy |
The fund is active for buying |
boolean |
is_active_sell |
The fund is active for selling |
boolean |
is_daily_traded |
True if the fund is daily traded |
boolean |
next_buy_day |
The next date buy orders will be processed (Only applicable for monthly traded funds) |
string |
next_sell_day |
The next date sell orders will be processed (Only applicable for monthly traded funds) |
string |
total_market_value |
Total market value |
number(float) |
trading_frequency |
Trading frequency expressed with keyword |
string |
FundUniverseModel
| Name | Description | Schema |
|---|---|---|
fund_universe_id |
The identifier of the fund universe |
integer(int64) |
FundlistInfo
| Name | Description | Schema |
|---|---|---|
fund_admin_company |
The name of the company administrating the fund |
string |
fund_branding_company |
Shorter 'Brand name' of the company administrating the fund |
string |
fund_calculated_fee |
Fund calculated fee |
number |
fund_category |
The funds category is a short description of the category of the fund |
string |
fund_esg_score |
ESG score for the fund |
integer(int32) |
fund_low_carbon |
Marks if the fund is a low carbon fund |
boolean |
fund_min_investment |
Minimum investment amount in user’s local currency |
integer(int32) |
fund_ms_rating |
The morningstar rating |
integer(int32) |
fund_nordnet_selection |
Marks if the fund is one of the nordnet selected ones |
boolean |
fund_platform_fee |
Fund platform fee |
number |
fund_raw_risk |
Risk as raw data. Value between 1-7 |
integer(int32) |
fund_refunding |
Fund refunding |
number |
fund_risk_group |
Translated risk grouped as low, mid, high |
string |
fund_start_date |
Date when the fund started as Epoch time |
integer(int64) |
fund_total_market_value |
Total market value for the fund |
integer(int64) |
fund_traded_when |
Translated traded when (= trade frequency) |
string |
fund_type |
Translated fund type |
string |
fund_universe_country |
The country of the funds universe |
string |
fund_universe_currency |
The currency of the funds universe |
string |
fund_yearly_fee |
Fund yearly fee |
number |
GenerationSavingsDetails
| Name | Description | Schema |
|---|---|---|
active |
If the generation savings plan is active |
boolean |
endAge |
The end age of the generation savings plan |
integer(int64) |
funds |
The funds that are part of the generation savings plan |
< GenerationSavingsFundModel > array |
startAge |
The start age of the generation savings plan |
integer(int64) |
GenerationSavingsFundModel
| Name | Description | Schema |
|---|---|---|
fundName |
The ins id of the fund |
string |
instrumentId |
The isin of the fund |
integer(int64) |
percentage |
The percentage of the generation savings that the fund represents |
integer(int64) |
GenerationSavingsModel
| Name | Description | Schema |
|---|---|---|
accid |
The accid this generation savings plan is tied to |
integer(int64) |
client |
The type of client used for generation savings plan |
string |
details |
The details of a generation savings plan |
< GenerationSavingsDetails > array |
GenericCharges
| Name | Description | Schema |
|---|---|---|
high_uncertainty |
Calculations in this category are likely incorrect/inaccurate |
boolean |
incidental |
Incidental charges |
|
one_off |
One off charges |
|
ongoing |
Ongoing charges |
|
total |
Nordnet total charges |
|
transactional |
Transactional fees |
GuidancePriceInfo
| Name | Description | Schema |
|---|---|---|
last_price |
'last' price if non-null/zero, otherwise 'close' price |
HistoricalReturnsInfo
| Name | Description | Schema |
|---|---|---|
realtime |
True if this historical returns info is based on a realtime snapshot |
boolean |
yield_10y |
Yield 10 years, diff in price between 'now' and 10 years ago |
number(double) |
yield_1m |
Yield 1 month, diff in price between 'now' and 1 month ago |
number(double) |
yield_1w |
Yield 1 week, diff in price between 'now' and last week |
number(double) |
yield_1y |
Yield 1 year, diff in price between 'now' and last year |
number(double) |
yield_3m |
Yield 3 months, diff in price between 'now' and 3 months ago |
number(double) |
yield_3y |
Yield 3 years, diff in price between 'now' and 3 years ago |
number(double) |
yield_5y |
Yield 5 years, diff in price between 'now' and 5 years ago |
number(double) |
yield_ytd |
Yield year to date, diff in price between 'now' and the start of the year |
number(double) |
HoldingPeriod
| Name | Description | Schema |
|---|---|---|
unit |
Time unit. Possible values ['YEARS', 'DAYS'] |
string |
value |
Number of units |
integer(int32) |
HorizonQuestion
| Name | Description | Schema |
|---|---|---|
answers |
Anwers |
< AnswersBody > array |
multiple_answer |
Multiple answers |
boolean |
IndexAttachmentMetaData
| Name | Description | Schema |
|---|---|---|
attachment_index |
sort order for the attachment |
string |
attachment_url |
url to load the attachment file |
string |
content_type |
the type of attachment |
string |
title |
attachment title |
string |
IndexMessage
| Name | Description | Schema |
|---|---|---|
accid |
The accid that this message was sent to |
integer(int32) |
answer |
True if message is answered |
boolean |
attachment_meta_data |
Information about attachments |
< IndexAttachmentMetaData > array |
best_before |
How long the message will be displayed for the customer |
integer(int32) |
from |
Who sent the message |
string |
message_id |
The id of the message |
integer(int32) |
prio |
How important the message is |
enum (urgent, important, default) |
sent |
True if message was sent by the customer |
boolean |
sent_at |
When the message was sent |
integer(int64) |
subject |
The subject of the message |
string |
viewed |
True if customer has viewed the message |
boolean |
Indicator
| Name | Description | Schema |
|---|---|---|
close |
The closing time on the format "HH:MM:SS" in UTC if available |
string |
country |
The country of the indicator if available |
string |
delayed |
The indicator prices is delayed in this many seconds. Defaults to 0. Should be ignored if only_eod is true |
integer(int64) |
identifier |
Identifier. source + identifier is unique |
string |
instrument_id |
Connect the indicator to an instrument. NOTE! Most indicators don’t have a real instrument |
integer(int64) |
name |
Translated name of the indicator |
string |
only_eod |
If true the price is only displayed end-of-day. Defaults to false |
boolean |
open |
The opening time on the format "HH:MM:SS" in UTC if available |
string |
region |
The region of the indicator if available. Country and region can’t be set at the same time |
string |
src |
Indicator source |
string |
type |
COMMODITY, CURRENCY, INTEREST or INDEX |
string |
IndicatorEntity
| Name | Description | Schema |
|---|---|---|
entity_type |
Specify the type of entity |
enum (COMMODITY, CURRENCY, INDEX, INTEREST) |
exchange_info |
Information regarding the instrument/tradable on the exchange |
|
historical_returns_info |
Historical returns information, showing the yield over time |
|
indicator_info |
Information regarding the indicator |
|
instrument_info |
Instrument information. The same instrument info may appear in multiple search results if there are multiple tradables or fund universes. |
|
price_info |
Price information, representing an exchange traded model containing top-of-book info |
IndicatorInfo
| Name | Description | Schema |
|---|---|---|
indicator_identifier |
Identifier of indicator |
string |
indicator_logged_in_delay |
Delay when logged in |
integer(int32) |
indicator_market_overview_group |
market overview group |
< string > array |
indicator_not_logged_in_delay |
Delay when not logged in |
integer(int32) |
indicator_src |
Source of indicator |
string |
indicator_src_delay |
Delay in seconds from source |
integer(int32) |
IndicatorResults
| Name | Description | Schema |
|---|---|---|
results |
The search results |
< IndicatorEntity > array |
rows |
Number of result rows returned |
integer(int32) |
total_hits |
Total number of search hits |
integer(int64) |
Instrument
Instrument definition
| Name | Description | Schema |
|---|---|---|
asset_class |
Asset class key word |
string |
currency |
The currency of the instrument |
string |
dividend_policy |
The dividend policy |
string |
expiration_date |
Expiration date if applicable. |
string(date) |
instrument_group_type |
The instrument group. Wider description than instrument type. The description is available in the instrument type lookup |
string |
instrument_id |
Unique identifier of the instrument. Can in some cases be 0 if the instrument is not tradable |
integer(int64) |
instrument_type |
The instrument type. |
string |
isin_code |
The instrument isin code |
string |
key_information_documents |
URLs to key information documents (KIDs) if available |
|
leverage_percentage |
The leverage percentage if applicable |
number(double) |
margin_percentage |
The margin percentage if applicable |
number(double) |
market_view |
Marking market view for leverage instruments. U for up and D for down |
string |
mifid2_category |
The mifid2 category of an instrument. Used to determine if a user can trade the instrument |
integer(int32) |
multiplier |
The instrument multiplier |
number(double) |
name |
The instrument name |
string |
number_of_securities |
Number of securities, not available for all instruments |
number(double) |
pawn_percentage |
The pawn percentage if applicable |
number(double) |
price_type |
Price type when trading, not available for all markets. Example: monetary_amount, percentage, yield |
string |
prospectus_url |
URL to prospectus if available |
string |
sector |
The sector id of the instrument |
string |
sector_group |
The sector group of the instrument |
string |
strike_price |
Strike price if applicable |
number(double) |
symbol |
The instrument symbol. E.g 'ERIC B' |
string |
total_fee |
Total fee |
number(double) |
tradables |
The tradables that belongs to the instrument. If the instrument is not tradable this field is left out |
< Tradable > array |
underlyings |
A list of underlyings to the instrument |
< UnderlyingInfo > array |
InstrumentAlarmDisplayed
| Name | Description | Schema |
|---|---|---|
active_notificationTypes |
These platforms will get notifications. Valid types are {"EMAIL", "MOBILE", "SMS", "WEB"} |
< string > array |
alarm_id |
The alarmId |
string |
close_price |
Close price |
number(double) |
currency |
Currency code |
string |
delay_type |
Delay type |
enum (0, 900) |
direction |
Direction |
string |
exchange_country |
Country code |
string |
identifier |
Identifier |
integer(int32) |
instrument_group_type |
The intrument group type |
string |
instrument_id |
The Nordnet instrument id |
integer(int32) |
instrument_type |
The intrument type |
string |
last_price |
Last price |
number(double) |
market_id |
The market ID |
integer(int32) |
name |
Name of the instrument |
string |
realtime |
Is price updated in realtime |
boolean |
snapshot_price |
The snapshot price |
number(double) |
snapshot_timestamp |
The snapshot timestamp |
integer(int64) |
symbol |
Symbol |
string |
trigger_level |
Trigger level |
number(double) |
update_timestamp |
The update timestamp |
integer(int64) |
InstrumentAlarmResult
| Name | Description | Schema |
|---|---|---|
active_notification_types |
These platforms will get notifications. Valid types are {"EMAIL", "MOBILE", "SMS", "WEB"} |
< string > array |
alarm_id |
The alarmId |
string |
close_price |
Close price |
number(double) |
currency |
Currency code |
string |
direction |
Direction |
string |
exchange_country |
Country code |
string |
identifier |
Identifier |
integer(int32) |
instrument_group_type |
The intrument group type |
string |
instrument_id |
The Nordnet instrument id |
integer(int32) |
instrument_type |
The intrument type |
string |
last_price |
Last price |
number(double) |
market_id |
The market ID |
integer(int32) |
name |
Name of the instrument |
string |
realtime |
Is price updated in realtime |
boolean |
snapshot_price |
The snapshot price |
number(double) |
snapshot_timestamp |
The snapshot timestamp |
integer(int64) |
symbol |
Symbol |
string |
trigger_level |
Trigger level |
number(double) |
update_timestamp |
The update timestamp |
integer(int64) |
InstrumentAlarmResults
| Name | Description | Schema |
|---|---|---|
results |
Price alarm fields |
< InstrumentAlarmResult > array |
rows |
Number of alarms displayed |
integer(int32) |
total_hits |
Total number of alarms for cutomer |
integer(int32) |
InstrumentEligability
| Name | Description | Schema |
|---|---|---|
eligible |
Is the customer eligable to trade the instrument |
boolean |
instrument_id |
The instrument identifier |
integer(int32) |
InstrumentEntity
| Name | Description | Schema |
|---|---|---|
exchange_info |
Information regarding the instrument/tradable on the exchange |
|
historical_returns_info |
Historical returns information, showing the yield over time |
|
instrument_info |
Instrument information. The same instrument info may appear in multiple search results if there are multiple tradables or fund universes. |
|
price_info |
Price information, representing an exchange traded model containing top-of-book info |
InstrumentFundGuidanceRequestBody
| Name | Description | Schema |
|---|---|---|
fund_categories |
Fund categories |
< string > array |
fund_filter_categories |
Filters to find right funds |
< string > array |
fund_instrument_type |
What type of funds to return |
enum (FUND, PINV, ETF) |
limit |
Objective for saving |
integer(int32) |
offset |
Period |
integer(int32) |
InstrumentFundGuidanceResponse
| Name | Description | Schema |
|---|---|---|
category |
The fund category |
string |
instruments |
List of funds |
< FundInstruments > array |
InstrumentInfo
| Name | Description | Schema |
|---|---|---|
clearing_place |
Same as clearing_place in service-instrument |
string |
currency |
Same as currency in service-instrument |
string |
display_name |
Country specific name (Only populated for Indicators) |
string |
instrument_group_type |
Same as instrument_group_type in service-instrument |
string |
instrument_id |
Same as instrument_id in service-instrument |
integer(int64) |
instrument_type |
Same as instrument_type in service-instrument |
string |
instrument_type_hierarchy |
Same as instrument_type_hierarchy in service-instrument |
string |
is_tradable |
Specifies if the instrument is tradable or not. For example, the instrument may be an untradable index or a tradable stock. |
boolean |
isin |
Same as isin_code in service-instrument |
string |
long_name |
The full name of the instrument, possibly in local language |
string |
name |
A short name intended for presentation |
string |
pawn_percentage |
Max pawn percentage |
integer(int32) |
symbol |
The Symbol of the instrument intended for presentation |
string |
InstrumentPublicTrades
| Name | Description | Schema |
|---|---|---|
instrument_id |
Unique identifier of the instrument |
integer(int32) |
trades |
A list of the public trades |
< PublicTrade > array |
InstrumentSearchResults
| Name | Description | Schema |
|---|---|---|
results |
The search results |
< InstrumentEntity > array |
rows |
Number of result rows returned |
integer(int32) |
total_hits |
Total number of search hits |
integer(int64) |
InstrumentType
| Name | Description | Schema |
|---|---|---|
instrument_type |
The instrument type code |
string |
name |
The translated name of the instrument |
string |
InstrumentUnderlyingInfo
| Name | Description | Schema |
|---|---|---|
instrument_id |
Unique identifier of the underlying instrument |
integer(int64) |
weight |
Weight percentage of this holding |
number(float) |
Instrumentdetails
| Name | Description | Schema |
|---|---|---|
currency |
Same as currency in service-instrument |
string |
diff_pct |
Diff in percent since last close price |
number(double) |
exchange_country |
Which country is the instrument traded in |
string |
instrument_group_type |
Same as instrument_group_type in service-instrument |
string |
instrument_id |
Same as instrument_id in service-instrument |
integer(int64) |
instrument_type |
Same as instrument_type in service-instrument |
string |
last |
Last price |
|
market_id |
Market id |
integer(int64) |
name |
A short name intended for presentation |
string |
realtime |
True if this price info is based on a realtime snapshot |
boolean |
symbol |
The Symbol of the instrument intended for presentation |
string |
timestamp |
Last tick timestamp |
integer(int64) |
IntradayGraph
| Name | Description | Schema |
|---|---|---|
identifier |
The tradable identifier. The combination of market_id and identifier is unique |
string |
market_id |
Unique market id |
integer(int64) |
ticks |
A list of price ticks |
< IntradayTick > array |
IntradayTick
| Name | Description | Schema |
|---|---|---|
high |
Highest price during this minute |
number(double) |
last |
Last price during this minute |
number(double) |
low |
Lowest price during this minute |
number(double) |
no_of_trades |
No of trades during this minute |
integer(int32) |
timestamp |
The timestamp in UTC |
integer(int32) |
volume |
Traded volume during this minute |
integer(int32) |
InvestmentApproximationRequest
| Name | Description | Schema |
|---|---|---|
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
investment_specifications |
List of purchases to base investment approximation on |
< InvestmentSpecification > array |
snapshot_limit |
Set number of returned snapshots. This is a best effort match and will always return a minimum of 2 snapshots |
integer(int32) |
InvestmentApproximationResponse
| Name | Description | Schema |
|---|---|---|
instrument_charges |
Instrument charges |
|
instrument_id |
Echoed instrument identifier |
integer(int32) |
kickback |
Kickback |
|
nordnet_charges |
Nordnet related charges |
|
snapshots |
Market value snapshots |
< Snapshot > array |
total |
Nordnet total charges |
InvestmentObjective
| Name | Description | Schema |
|---|---|---|
investment_objective_question |
Investment objective question |
InvestmentObjectiveQuestion
| Name | Description | Schema |
|---|---|---|
answers |
Anwers |
< AnswersBody > array |
multiple_answer |
Multiple answers |
boolean |
InvestmentSpecification
| Name | Description | Schema |
|---|---|---|
continuous_deposit |
Continuously added investments in the instrument |
|
custom_charges |
List of custom charges that can be added, e.g. Robosave fee |
< CustomCharge > array |
expected_return |
Expected return in fraction |
number(float) |
holding_period |
How long to hold the investment |
|
instrument_id |
Instrument identifier |
integer(int32) |
result_currency |
The currency to have all the reponse amounts in |
string |
trade_amount |
Investment amount |
Issuer
| Name | Description | Schema |
|---|---|---|
issuer_id |
Unique id of the issuer |
integer(int64) |
name |
Name of the issuer |
string |
Jwk
| Name | Description | Schema |
|---|---|---|
alg |
Identifies the algorrithm intended for use with the key |
string |
e |
The exponent for a standard pem |
string |
kty |
Key Type. Identifies the cryptographic algorithm family used with the key |
enum (RSA, EC) |
n |
The modulus for a standard pem |
string |
use |
Indicates wether the intended use of the public key is validating signatures or encryption |
enum (sig, enc) |
Jwks
| Name | Description | Schema |
|---|---|---|
keys |
The active keys which current valid JWTs may have been signed by |
< Jwk > array |
JwtResponse
| Name | Description | Schema |
|---|---|---|
jwt |
The fresh Json Web Token in base64 format |
string |
KeyInformationDocuments
| Name | Description | Schema |
|---|---|---|
url_for_combined |
The URL of the key information document (KID). Link to a Combined KID document |
string |
url_for_long |
The URL of the key information document (KID). Link to a Long KID document |
string |
url_for_short |
The URL of the key information document (KID). Link to a Short KID document |
string |
KeyRatiosInfo
| Name | Description | Schema |
|---|---|---|
dividend_per_share |
Dividend per share (Utdelning/Aktie) |
number(double) |
dividend_yield |
Dividend yield (Direktavkastning) |
number(double) |
eps |
EPS, earnings per share (Vinst/Aktie) |
number(double) |
pb |
P/B ratio, price to book |
number(double) |
pe |
P/E ratio, price to earnings |
number(double) |
ps |
P/S ratio, price to sales |
number(double) |
KoInfo
| Name | Description | Schema |
|---|---|---|
financial_level |
Financial level (strike price) |
number(double) |
stop_loss |
Stop loss (barrier price) |
number(double) |
Ledger
| Name | Description | Schema |
|---|---|---|
acc_int_cred |
Interest credit in the ledger currency |
|
acc_int_deb |
Interest debit in the ledger currency |
|
account_sum |
The sum in the ledger currency |
|
account_sum_acc |
The sum in the account currency |
|
currency |
Currency of the ledger |
string |
exchange_rate |
The price to convert to base currency |
LedgerInformation
| Name | Description | Schema |
|---|---|---|
ledgers |
Each ledger |
< Ledger > array |
total |
Total of all the ledgers in the account currency |
|
total_acc_int_cred |
Total interest credit in the account currency |
|
total_acc_int_deb |
Total interest debit in the account currency |
LeverageFilter
| Name | Description | Schema |
|---|---|---|
currencies |
List of valid currencies |
< string > array |
expiration_dates |
List of valid expiry dates |
< string > array |
instrument_group_types |
List of valid instrument group types |
< string > array |
instrument_types |
List of valid instrument types |
< string > array |
issuers |
List of valid issuer_id and issuer_name |
< Issuer > array |
market_view |
List of valid market views |
< string > array |
no_of_instruments |
Number of derivatives if this filter is used |
integer(int64) |
LiquidationApproximationRequest
| Name | Description | Schema |
|---|---|---|
accid |
The account id that identifers the account. Some systems can or must use the accno as accid |
integer(int64) |
liquidation_specifications |
List of sales to base liquidation approximation on |
< LiquidationSpecification > array |
LiquidationApproximationResponse
| Name | Description | Schema |
|---|---|---|
instrument_charges |
Instrument charges |
|
instrument_id |
Unique instrument identifier |
integer(int32) |
kickback |
Kickback |
|
nordnet_charges |
Nordnet related charges |
|
total |
Nordnet total charges |
LiquidationSpecification
| Name | Description | Schema |
|---|---|---|
holding_period |
How long to hold the investment |
|
instrument_id |
Unique instrument identifier |
integer(int32) |
result_currency |
The currency to have all the reponse amounts in |
string |
trade_amount |
Sell amount |
List
| Name | Description | Schema |
|---|---|---|
country |
The country of the list if available. |
string |
display_order |
Used for sorting the list before displaying them to the end user. |
integer(int64) |
list_id |
Unique id for the list |
integer(int64) |
name |
The translated name of the list. |
string |
region |
The region of the list if available. |
string |
symbol |
The short name of the symbol. |
string |
LoggedInStatus
| Name | Description | Schema |
|---|---|---|
logged_in |
True if the session is valid |
boolean |
Login
| Name | Description | Schema |
|---|---|---|
environment |
The environment of the server. Examples: production, test |
string |
expires_in |
The session expire interval in seconds. Note: this is not the remaining time until session timeout it is the interval |
integer(int64) |
private_feed |
Connection information for the private feed |
|
public_feed |
Connection information for the public feed |
|
session_key |
The session key used for identification in all other requests |
string |
Market
| Name | Description | Schema |
|---|---|---|
country |
The country code, available for all non virtual markets |
string |
market_id |
The Nordnet unique identifier of the market. |
integer(int64) |
name |
The name of the market |
string |
MarketInfo
| Name | Description | Schema |
|---|---|---|
identifier |
Market identifier |
string |
market_id |
Market id |
integer(int64) |
market_sub_id |
Market sub id |
integer(int64) |
tick_size_id |
Tick size id for the tick size table to use, when applicable |
integer(int64) |
Mifid2CategoriesModel
| Name | Description | Schema |
|---|---|---|
mifid2_categories |
A list of approved mifid2 categories |
< integer > array |
MinifutureEntity
| Name | Description | Schema |
|---|---|---|
etp_info |
ETP information |
|
exchange_info |
Information regarding the instrument/tradable on the exchange |
|
instrument_info |
Instrument information. The same instrument info may appear in multiple search results if there are multiple tradables or fund universes. |
|
ko_info |
Information related to knock-out instruments |
|
market_info |
Market information, identifies which market the price info is collected from |
|
price_info |
Price information, representing an exchange traded model containing top-of-book info |
|
price_ko_info |
Knock-out instrument related price information |