Settle

PreviousPool NextExercise

Last updated 12 months ago

Was this helpful?

Settles all short positions in each specified option in the request.

post

/pool/settle

Authorizations

Body

basestringrequired

Example: WETH

quotestringrequired

Example: USDC

expirationstringrequired

Example: 03NOV23

Pattern: ^\d\d\w\w\w\d\d$

strikenumberrequired

Example: 1700

typestringrequired

Example: C

Pattern: ^C$|^P$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/pool/settle' \
  --header 'x-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '[{"base":"WETH","quote":"USDC","expiration":"03NOV23","strike":1700,"type":"C"}]'

200

400

401

{
  "success": [
    {
      "base": "WETH",
      "quote": "USDC",
      "expiration": "03NOV23",
      "strike": 1700,
      "type": "P"
    }
  ],
  "failed": [
    {
      "reason": "text",
      "failedOption": {
        "base": "WETH",
        "quote": "USDC",
        "expiration": "03NOV23",
        "strike": 1700,
        "type": "P"
      }
    }
  ]
}

Positions settled