# Net Flow Expiry

`GET` `https://api.unusualwhales.com/api/net-flow/expiry`

Returns net premium flow by `tide_type` category, `moneyness` category, and `expiration` category, allowing you to create chart variations like [https://unusualwhales.com/zero-dte](https://unusualwhales.com/zero-dte):

![zero dte](https://storage.googleapis.com/uwassets/img/zero-dte-type-charts.png)

About the query parameters:

- **`tide_type`**: For example, setting `tide_type` to "equity_only" will filter out ETFs and indexes, leaving only net premium from single-name equities.

- **`moneyness`**: For example, setting `moneyness` to "otm" will filter out any contract that was not out of the money ("OTM") at the time of the transaction, leaving only net premium from contracts that were OTM at the time of the transaction.

- **`expiration`**: For example, setting `expiration` to "zero_dte" will filter out any contract not expiring this session, leaving only net premium from contracts expiring at 4PM eastern time today.



## Authentication

```
Authorization: Bearer YOUR_API_KEY
```

## Query Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `date` | Optional Market Date | No | Market date to get data for (defaults to last market day) |
| `moneyness` | array[string] | No | Moneyness filter (defaults to 'all') |
| `tide_type` | array[string] | No | Tide type filter (defaults to 'all') |
| `expiration` | array[string] | No | Expiration filter (defaults to ['weekly', 'zero_dte']) |


## Response (200)

| Field | Type | Description |
|-------|------|-------------|
| `data` | array[Expiry Tide Group] | Array of net flow data groups |
| `date` | string | Date of the data |
| `expiration` | array[string] | Expiration filters applied |
| `moneyness` | array[string] | Moneyness filters applied |
| `tide_type` | array[string] | Tide type filters applied |


## Example

### curl

```bash
curl -X GET "https://api.unusualwhales.com/api/net-flow/expiry" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
```

### Python

```python
import http.client

conn = http.client.HTTPSConnection("api.unusualwhales.com")
headers = {"Authorization": "Bearer YOUR_API_KEY", "Accept": "application/json"}
conn.request("GET", "/api/net-flow/expiry", headers=headers)
response = conn.getresponse()
print(response.read().decode("utf-8"))
```

## Response Example

```json
{
  "data": [
    {
      "data": null,
      "moneyness": "all",
      "tide_type": "equity_only"
    }
  ],
  "date": "2023-01-15",
  "expiration": [
    "weekly",
    "zero_dte"
  ],
  "moneyness": [
    "all"
  ],
  "tide_type": [
    "equity_only"
  ]
}
```