Skip to main content
POST
/
api
/
v1
/
custom
/
org
/
{organization_uuid}
/
optimized_proposals
/
list
cURL
curl --request POST \
  --url https://api.tilt.io/api/v1/custom/org/{organization_uuid}/optimized_proposals/list/ \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "status": "pending",
  "client_external_id": "<string>",
  "created_after": "2023-11-07T05:31:56Z",
  "created_before": "2023-11-07T05:31:56Z",
  "min_average_drift": "<string>",
  "min_largest_drift": "<string>",
  "min_turnover": "<string>",
  "min_tax_due": "<string>",
  "min_buy_amount_usd": "<string>",
  "min_sell_amount_usd": "<string>"
}
'
{
  "count": 123,
  "results": [
    {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "client_external_id": "<string>",
      "client_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "last_updated": "2023-11-07T05:31:56Z",
      "average_drift": "<string>",
      "max_drift": "<string>",
      "failure_reason": "<string>"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
organization_uuid
string<uuid>
required

Query Parameters

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

Body

Request serializer for filtering optimized proposals.

​
status

Filter by proposal status

  • pending - Pending
  • completed - Completed
  • failed - Failed
Available options:
pending,
completed,
failed
​
client_external_id
string | null

Filter by client external ID

​
created_after
string<date-time> | null

Filter proposals created after this date/time

​
created_before
string<date-time> | null

Filter proposals created before this date/time

​
min_average_drift
string<decimal> | null

Filter proposals by the average drift across all holdings.

Pattern: ^-?\d{0,8}(?:\.\d{0,8})?$
​
min_largest_drift
string<decimal> | null

Filter proposals by the largest drift across all holdings.

Pattern: ^-?\d{0,8}(?:\.\d{0,8})?$
​
min_turnover
string<decimal> | null

Filter proposals by the proposal turnover

Pattern: ^-?\d{0,12}(?:\.\d{0,4})?$
​
min_tax_due
string<decimal> | null

Filter proposals by the tax due

Pattern: ^-?\d{0,12}(?:\.\d{0,4})?$
​
min_buy_amount_usd
string<decimal> | null

Filter proposals by the total buy trades in USD

Pattern: ^-?\d{0,12}(?:\.\d{0,4})?$
​
min_sell_amount_usd
string<decimal> | null

Filter proposals by the total absolute sell amount in USD.

Pattern: ^-?\d{0,12}(?:\.\d{0,4})?$

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"