> This page is for Web API.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://ibkrcampus.com/docs/llms.txt.

# Search Instruments By Symbol

POST https://localhost:5000/v1/api/iserver/secdef/search
Content-Type: application/json

Returns a list of contracts based on the search symbol provided as a query param.

Reference: https://ibkrcampus.com/docs/web-api/api-reference/trading/trading-contracts/get-contract-symbols

## Authentication

- `Authorization` header (bearer token, required) — SSO bearer token.

## Servers

- `https://localhost:5000` (Client Portal Gateway, default)
- `https://api.ibkr.com` (Production)
- `https://qa.interactivebrokers.com` (Sandbox)

## Request

### Body (application/json)

This endpoint expects an object.

- `symbol` (string, required) — The ticker symbol, bond issuer type, or company name of the equity you are looking to trade.
- `secType` (enum, optional, default: STK) — Available underlying security types: * `STK` - Represents an underlying as a Stock security type. * `IND` - Represents an underlying as an Index security type. * `BOND` - Represents an underlying as a Bond security type.
  - Allowed values: `STK`, `IND`, `BOND`
- `name` (boolean, optional) — Denotes if the symbol value is the ticker symbol or part of the company's name.
- `more` (boolean, optional)
- `fund` (boolean, optional) — fund search
- `fundFamilyConidEx` (string, optional)
- `pattern` (boolean, optional) — pattern search
- `referrer` (string, optional)

## Response

### 200

An array of objects detailing contract information.

- `list of SecdefSearchResponseItems`

## Errors

### 400 Bad Request Error

Missing, empty, non-numeric, or out-of-range parameter. The `error` field is always prefixed with `Bad Request:`.

- `status` (long, optional)
- `error` (string, optional)
- `message` (string, optional)

### 401 Unauthorized Error

Missing, invalid, or unparseable Authorization token.

- `status` (long, optional)
- `error` (string, optional)
- `message` (string, optional)

### 500 Internal Server Error

internal server error, returned when incoming request cannot be processed. It can sometimes include subset of bad requests. For example, wrong accountId passed and it can only be detected later in handling request. Error contains reason of the problem.

- `error` (string, optional) — error reason

### 503 Service Unavailable Error

service is unavailable. For example if request takes more than 10s due to some internal service unavailability, request aborted and this status returned

- `error` (string, optional) — error reason
- `statusCode` (long, optional) — mimic response status code

## Types

### SecdefSearchResponseItems

- `bondid` (long, optional) — applicable for bonds
- `conid` (string, optional) — Contract identifier for the unique contract.
- `companyHeader` (string, optional) — Company Name - Exchange
- `companyName` (string, optional, nullable) — Formal name of the company.
- `symbol` (string, optional) — Underlying ticker symbol.
- `description` (string, optional) — Primary exchange of the contract
- `restricted` (boolean, optional, nullable) — Returns if the contract is available for trading.
- `fop` (string, optional, nullable) — Returns a string of dates, separated by semicolons.
- `opt` (string, optional, nullable) — Returns a string of dates, separated by semicolons.
- `war` (string, optional, nullable) — Returns a string of dates, separated by semicolons.
- `sections` (list of SecdefSearchResponseItemsSectionsItems, optional)
- `issuers` (list of SecdefSearchResponseItemsIssuersItems, optional)

### SecdefSearchResponseItemsSectionsItems

- `secType` (string, optional)
- `months` (string, optional) — semicolon separated list of months
- `exchange` (string, optional) — semicolon separated list of exchanges

### SecdefSearchResponseItemsIssuersItems

- `id` (string, optional)
- `name` (string, optional)

## Examples

**Request**

```json
{
  "symbol": "AAPL"
}
```

**Response**

```json
[
  {
    "bondid": 1,
    "conid": "string",
    "companyHeader": "string",
    "companyName": "string",
    "symbol": "string",
    "description": "string",
    "restricted": true,
    "fop": "string",
    "opt": "string",
    "war": "string",
    "sections": [
      {
        "secType": "string",
        "months": "string",
        "exchange": "string"
      }
    ],
    "issuers": [
      {
        "id": "string",
        "name": "string"
      }
    ]
  }
]
```

**SDK Code**

```python
import requests

url = "https://localhost:5000/v1/api/iserver/secdef/search"

payload = { "symbol": "AAPL" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://localhost:5000/v1/api/iserver/secdef/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"symbol":"AAPL"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://localhost:5000/v1/api/iserver/secdef/search"

	payload := strings.NewReader("{\n  \"symbol\": \"AAPL\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://localhost:5000/v1/api/iserver/secdef/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"symbol\": \"AAPL\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://localhost:5000/v1/api/iserver/secdef/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"symbol\": \"AAPL\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://localhost:5000/v1/api/iserver/secdef/search', [
  'body' => '{
  "symbol": "AAPL"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://localhost:5000/v1/api/iserver/secdef/search");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"symbol\": \"AAPL\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["symbol": "AAPL"] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://localhost:5000/v1/api/iserver/secdef/search")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```