Skip to content
Inflection API

Settled positions

GET
/api/trading/accounts/{account_id}/settlements
curl --request GET \
  --url 'https://example.com/api/trading/accounts/1/settlements?limit=200' \
  --header 'INF-ACCESS-KEY: <INF-ACCESS-KEY>' \
  --header 'INF-ACCESS-SIGNATURE: <INF-ACCESS-SIGNATURE>' \
  --header 'INF-ACCESS-TIMESTAMP: <INF-ACCESS-TIMESTAMP>'

Positions whose market has settled.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
account_id
required
Account Id
integer

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 200

At most this many, up to 1,000.

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Settlements
object
settlements
required
Settlements
Array<object>
Settled
object
market_id
required
Market Id
integer
outcome
required
Outcome
string
Allowed values: up down
quantity
required
Quantity
integer
cost_basis
required
Cost Basis
integer
payout
required
Any of:
integer
realized_pnl
required
Realized Pnl
integer
pnl
required
Pnl

Payout less cost basis.

integer
Example
{
  "settlements": [
    {
      "outcome": "up"
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}