Tiger Open API

https://quant.itigerup.com/openapi/
Admin
The Tiger Open API provides interface services for individual developers and institutional clients,...
Tokens:3,095
Snippets:6
Trust Score:8.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Option Chain Response Example

Source: https://quant.itigerup.com/openapi/en/java/operation/quotation/option.html

Example of a successful response when retrieving an option chain. This includes details for put options with their respective prices, sizes, and Greeks.

```json
{
    "code": 0,
    "data": [
        {
            "expiry": 1721966400000,
            "items": [
                {
                    "put": {
                        "askPrice": 4.65,
                        "askSize": 2,
                        "bidPrice": 4.5,
                        "bidSize": 66,
                        "delta": -0.503388,
                        "gamma": 0.037062,
                        "identifier": "AAPL  240726P00210000",
                        "impliedVol": 0.183129,
                        "lastTimestamp": 1719345582586,
                        "latestPrice": 4.6,
                        "multiplier": 100,
                        "openInterest": 1858,
                        "preClose": 5.26,
                        "rho": -0.072819,
                        "right": "put",
                        "strike": "210.0",
                        "theta": -0.060326,
                        "vega": 0.24135,
                        "volume": 404
                    }
                },
                {
                    "put": {
                        "askPrice": 7.75,
                        "askSize": 59,
                        "bidPrice": 7.4,
                        "bidSize": 260,
                        "delta": -0.686314,
                        "gamma": 0.03523,
                        "identifier": "AAPL  240726P00215000",
                        "impliedVol": 0.18012,
                        "lastTimestamp": 1719345365800,
                        "latestPrice": 7.8,
                        "multiplier": 100,
                        "openInterest": 1222,
                        "preClose": 8.5,
                        "rho": -0.084955,
                        "right": "put",
                        "strike": "215.0",
                        "theta": -0.048649,
                        "vega": 0.21153,
                        "volume": 134
                    }
                }
            ],
            "symbol": "AAPL"
        }
    ],
    "message": "success",
    "sign": "dA0ngWPHWC0GOme2h0/FPma5UAcLSKiR5vWw9ldZ1wz8sHiRG7QMroO78JXqK5A+J3m6XWT9esAXagwbs8D6mI/3vhFU5QCJQbDd58lQRJRWeAK/G+7eQOwAQIqvgLttBtMBbRKlHMchhHATgUi9U7v/eu4NG5tDHr04InQy0cc=",
    "success": true,
    "timestamp": 1719407360986
}
```

--------------------------------

### Get Option Timeline Data

Source: https://quant.itigerup.com/openapi/en/java/operation/quotation/option.html

Demonstrates how to construct an OptionTimelineRequest with multiple OptionTimelineModel objects and execute it using the client. Handles success and error responses.

```java
OptionTimelineModel model1 = new OptionTimelineModel();
model1.setSymbol("ALB.HK");
model1.setExpiry(1753878054000L);
model1.setStrike("117.50");
model1.setRight("CALL");

OptionTimelineModel model2 = new OptionTimelineModel();
model2.setSymbol("LNI.HK");
model2.setExpiry(1753878054000L);
model2.setStrike("17.00");
model2.setRight("PUT");

OptionTimelineRequest request = OptionTimelineRequest.of(model1, model2);

OptionTimelineResponse response = client.execute(request);
if (response.isSuccess()) {
    System.out.println(JSONObject.toJSONString(response));
} else {
    System.out.println("response error:" + response.getMessage());
}
```

--------------------------------

### Get option timeline

Source: https://quant.itigerup.com/openapi/en/java/operation/quotation/option.html

Retrieves the timeline data for a list of specified options. Supports options for the Hong Kong market.

```APIDOC
## Get option timeline

### Description
Get the timeline data of option.

### Method
POST (Implied by the example usage of a client executing a request)

### Endpoint
Not explicitly defined, but implied to be an endpoint that accepts OptionTimelineRequest.

### Parameters
#### Request Body
- **optionTimelineModels** (List<OptionTimelineModel>) - Required - List of options to query.
- **market** (Market) - Optional - Market for the options (default: HK, currently only HK supported).

**OptionTimelineModel Structure:**
- **symbol** (string) - Required - Stock symbol.
- **right** (string) - Required - Call or Put (CALL/PUT).
- **expiry** (long) - Required - Expiry timestamp.
- **strike** (string) - Required - Strike price.

### Request Example
```java
OptionTimelineModel model1 = new OptionTimelineModel();
model1.setSymbol("ALB.HK");
model1.setExpiry(1753878054000L);
model1.setStrike("117.50");
model1.setRight("CALL");

OptionTimelineModel model2 = new OptionTimelineModel();
model2.setSymbol("LNI.HK");
model2.setExpiry(1753878054000L);
model2.setStrike("17.00");
model2.setRight("PUT");

OptionTimelineRequest request = OptionTimelineRequest.of(model1, model2);

// Assuming 'client' is an initialized API client
// OptionTimelineResponse response = client.execute(request);
```

### Response
#### Success Response (200 OK)
- **timelineItems** (List<OptionTimelineItem>) - List of timeline data for each queried option.

**OptionTimelineItem Structure:**
- **symbol** (string) - Stock symbol.
- **expiry** (long) - Expiry timestamp.
- **right** (string) - Call or Put (CALL/PUT).
- **strike** (string) - Strike price.
- **preClose** (double) - Previous closing price.
- **openAndCloseTimeList** (List<List<Long>>) - List of trading sessions.
- **minutes** (List<OptionTimelinePoint>) - Timeline data array.

**OptionTimelinePoint Structure:**
- **volume** (long) - Trading volume.
- **avgPrice** (double) - Average transaction price.
- **price** (double) - Latest price.
- **time** (long) - Current timeline timestamp.

#### Response Example
```json
{
  "code" : 0,
  "message" : "success",
  "timestamp" : 1750822293909,
  "sign" : "rEiaFf1LYv32Kbu8C+AKpJ/Y9pjrux8usbFA3FFJUEP28EXHv+PnKX9RBtVLalkyrULNqDqS29zP9hF1OZAng7U9KWFQ1Gy/FcGdbypXRNeJxPgKefHt/Fe4rLweO/eWKE41ZprPZlUZX0fxfeMwqkwcTMfhpuu+HQ2/ocmMgeg=",
  "timelineItems" : [
    {
      "symbol" : "ALB.HK",
      "expiry" : 1753878054000,
      "right" : "CALL",
      "strike" : "117.50",
      "preClose" : 2.72,
      "minutes" : [
        {
          "price" : 3.4,
          "avgPrice" : 3.5235946,
          "time" : 1750822140000,
          "volume" : 29
        }
      ]
    }
  ],
  "success" : true
}
```
```

--------------------------------

### Get Option Chain

Source: https://quant.itigerup.com/openapi/en/java/operation/quotation/option.html

Fetches the option chain for a specified stock symbol. The response includes expiry dates and detailed information for each option contract (put/call).

```APIDOC
## GET /option/chain

### Description
Retrieves the option chain for a given stock symbol. This endpoint provides details on available option contracts, including expiry dates, strike prices, and market data for puts and calls.

### Method
GET

### Endpoint
/option/chain

### Parameters
#### Query Parameters
- **symbol** (string) - Required - The stock symbol for which to retrieve the option chain (e.g., AAPL).

### Response
#### Success Response (200)
- **code** (integer) - Response code.
- **data** (array) - Array of option chain data.
  - **expiry** (long) - Expiry timestamp of the option contract.
  - **items** (array) - Array of option items.
    - **put** (object) - Details for a put option.
      - **askPrice** (number) - The asking price for the option.
      - **askSize** (integer) - The number of contracts available at the ask price.
      - **bidPrice** (number) - The bidding price for the option.
      - **bidSize** (integer) - The number of contracts available at the bid price.
      - **delta** (number) - The delta of the option.
      - **gamma** (number) - The gamma of the option.
      - **identifier** (string) - Unique identifier for the option contract.
      - **impliedVol** (number) - The implied volatility of the option.
      - **lastTimestamp** (long) - Timestamp of the last trade.
      - **latestPrice** (number) - The latest trading price of the option.
      - **multiplier** (integer) - The contract multiplier.
      - **openInterest** (integer) - The total number of open contracts.
      - **preClose** (number) - The previous day's closing price.
      - **rho** (number) - The rho of the option.
      - **right** (string) - The type of option ('put' or 'call').
      - **strike** (string) - The strike price of the option.
      - **theta** (number) - The theta of the option.
      - **vega** (number) - The vega of the option.
      - **volume** (integer) - The trading volume for the option.
    - **call** (object) - Details for a call option (structure similar to 'put').
- **message** (string) - Response message.
- **sign** (string) - Signature for response verification.
- **success** (boolean) - Indicates if the request was successful.
- **timestamp** (long) - Timestamp of the response.

#### Response Example
```json
{
    "code": 0,
    "data": [
        {
            "expiry": 1721966400000,
            "items": [
                {
                    "put": {
                        "askPrice": 4.65,
                        "askSize": 2,
                        "bidPrice": 4.5,
                        "bidSize": 66,
                        "delta": -0.503388,
                        "gamma": 0.037062,
                        "identifier": "AAPL  240726P00210000",
                        "impliedVol": 0.183129,
                        "lastTimestamp": 1719345582586,
                        "latestPrice": 4.6,
                        "multiplier": 100,
                        "openInterest": 1858,
                        "preClose": 5.26,
                        "rho": -0.072819,
                        "right": "put",
                        "strike": "210.0",
                        "theta": -0.060326,
                        "vega": 0.24135,
                        "volume": 404
                    }
                }
            ],
            "symbol": "AAPL"
        }
    ],
    "message": "success",
    "sign": "dA0ngWPHWC0GOme2h0/FPma5UAcLSKiR5vWw9ldZ1wz8sHiRG7QMroO78JXqK5A+J3m6XWT9esAXagwbs8D6mI/3vhFU5QCJQbDd58lQRJRWeAK/G+7eQOwAQIqvgLttBtMBbRKlHMchhHATgUi9U7v/eu4NG5tDHr04InQy0cc=",
    "success": true,
    "timestamp": 1719407360986
}
```
```

--------------------------------

### Get Futures Main Historical Contract Codes

Source: https://quant.itigerup.com/openapi/en/java/operation/quotation/future.html

Use this to retrieve historical contract codes for futures. Ensure the TimeZoneId is correctly specified if not using the default.

```java
List<String> contractCodes = new ArrayList<>();
contractCodes.add("ESmain");
FutureHistoryMainContractRequest request = FutureHistoryMainContractRequest.newRequest(contractCodes,
  "2023-06-01", "2023-10-05", TimeZoneId.NewYork);
FutureHistoryMainContractResponse response = client.execute(request);
if (response.isSuccess()) {
  System.out.println(JSONObject.toJSONString(response));
} else {
  System.out.println(response.getMessage());
}
```

--------------------------------

### Get futures main's historical contract codes

Source: https://quant.itigerup.com/openapi/en/java/operation/quotation/future.html

Retrieves a list of historical contract codes for futures, based on provided contract codes, time range, and optional timezone.

```APIDOC
## Get futures main's historical contract codes

### Description
Get futures main's historical contract codes.

### Method
POST

### Endpoint
/futures/history/main/contracts

### Parameters
#### Query Parameters
- **contractCodes** (List<String>) - Required - futures code list
- **beginTime** (Long/String) - Required - Begin time(exclude), millisecond timestamp
- **endTime** (Long/String) - Required - End time(include), millisecond timestamp
- **zoneId** (TimeZoneId) - Optional - Description of the timezone used

### Response
#### Success Response (200)
- **contractCode** (String) - Futures main contract code
- **mainReferItems** (List<FutureHistoryContractItem>) - List of historical futures contract code
  - **referContractCode** (String) - Futures main's historical contract code
  - **time** (long) - timestamp

### Response Example
{
    "code":0,
    "data":[
        {
            "contractCode":"ESmain",
            "mainReferItems":[
                {
                    "referContractCode":"ES2312",
                    "time":1696453200000
                }
            ]
        }
    ]
}
```
Tokens:
Raw