Search Bond Filter Information

GET

/iserver/secdef/bond-filters

GET

/v1/api/iserver/secdef/bond-filters

$ curl -G https://api.ibkr.com/v1/api/iserver/secdef/bond-filters \
>      -d issuerId=e1400715 \
>      -d symbol=BOND

1 {
2   "bondFilters": [
3     {
4       "displayText": "Maturity Date",
5       "columnId": 27,
6       "options": [
7         {
8           "value": "202501",
9           "text": "Jan 2025"
10         },
11         {
12           "value": "202812",
13           "text": "Dec 2028"
14         }
15       ]
16     },
17     {
18       "displayText": "Issue Date",
19       "columnId": 28,
20       "options": [
21         {
22           "value": "20140918",
23           "text": "Sep 18 2014"
24         },
25         {
26           "value": "20150409",
27           "text": "Apr 09 2015"
28         }
29       ]
30     },
31     {
32       "displayText": "Coupon",
33       "columnId": 25,
34       "options": [
35         {
36           "value": "1.301"
37         },
38         {
39           "value": "1.34"
40         }
41       ]
42     },
43     {
44       "displayText": "Currency",
45       "columnId": 5,
46       "options": [
47         {
48           "value": "EUR"
49         },
50         {
51           "value": "USD"
52         }
53       ]
54     }
55   ]
56 }

Request a list of filters relating to a given Bond issuerID. The issuerId is retrieved from /iserver/secdef/search and can be used in /iserver/secdef/info?issuerId={issuerId} for retrieving conIds.

Query parameters

symbolstringRequired

issuerIdstringRequired

Response

Successful requests return the currency exchange rate of the target currency value divided by the source currency.

bondFilterslist of objects

Contains all filters pertaining to the given issuerId

Errors

401

Unauthorized Error

500

Internal Server Error

503

Service Unavailable Error