GET v1/Bonds/Search

Search for a bond using the CUSIP or ISIN.

Request Information

Parameters

Name	Type	Description	Additional information
request	BondSearchRequest	Container for the Bond Search Request input parameters. See parameter details below.	Define this parameter in the request URI.
useStaticList	Boolean	Allows to use static search index for batch processing. Improves performance	Define this parameter in the request URI.

Parameter Information

Parameter Name: request

Property	Type	Description
Query	String	Search for an Bond by name, CUSIP, or ISIN.
MaxResults	Int32	Specifies the maximum number of records to return. This field is optional. The default is 10.
SdkVersion	String	If the client is using the SDK, the version number will be passed along with the request. This field is optional.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "bonds": [
    {
      "instrumentId": 1,
      "pid": "sample string 2",
      "ticker": "sample string 3",
      "issueName": "sample string 4",
      "issueNameShort": "sample string 5",
      "cusip": "sample string 6",
      "isin": "sample string 7",
      "currency": "sample string 8",
      "scale": 9
    },
    {
      "instrumentId": 1,
      "pid": "sample string 2",
      "ticker": "sample string 3",
      "issueName": "sample string 4",
      "issueNameShort": "sample string 5",
      "cusip": "sample string 6",
      "isin": "sample string 7",
      "currency": "sample string 8",
      "scale": 9
    },
    {
      "instrumentId": 1,
      "pid": "sample string 2",
      "ticker": "sample string 3",
      "issueName": "sample string 4",
      "issueNameShort": "sample string 5",
      "cusip": "sample string 6",
      "isin": "sample string 7",
      "currency": "sample string 8",
      "scale": 9
    }
  ],
  "errorOccurred": false,
  "errorMessages": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "request": {
    "query": "sample string 1",
    "maxResults": 2,
    "sdkVersion": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<BondSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </ErrorMessages>
  <ErrorOccurred>false</ErrorOccurred>
  <Request>
    <SdkVersion>sample string 3</SdkVersion>
    <MaxResults>2</MaxResults>
    <Query>sample string 1</Query>
  </Request>
  <Bonds>
    <Bond>
      <Currency>sample string 8</Currency>
      <Cusip>sample string 6</Cusip>
      <InstrumentId>1</InstrumentId>
      <Isin>sample string 7</Isin>
      <IssueName>sample string 4</IssueName>
      <IssueNameShort>sample string 5</IssueNameShort>
      <Pid>sample string 2</Pid>
      <Scale>9</Scale>
      <Ticker>sample string 3</Ticker>
    </Bond>
    <Bond>
      <Currency>sample string 8</Currency>
      <Cusip>sample string 6</Cusip>
      <InstrumentId>1</InstrumentId>
      <Isin>sample string 7</Isin>
      <IssueName>sample string 4</IssueName>
      <IssueNameShort>sample string 5</IssueNameShort>
      <Pid>sample string 2</Pid>
      <Scale>9</Scale>
      <Ticker>sample string 3</Ticker>
    </Bond>
    <Bond>
      <Currency>sample string 8</Currency>
      <Cusip>sample string 6</Cusip>
      <InstrumentId>1</InstrumentId>
      <Isin>sample string 7</Isin>
      <IssueName>sample string 4</IssueName>
      <IssueNameShort>sample string 5</IssueNameShort>
      <Pid>sample string 2</Pid>
      <Scale>9</Scale>
      <Ticker>sample string 3</Ticker>
    </Bond>
  </Bonds>
</BondSearchResponse>