Discounting API

PreviousReporting API NextThird Party Integration Guides

Last updated 4 months ago

Was this helpful?

Create a discounted fee rate for an account

post

/v0/platform/accounts/{idOrKey}/discount_rate

Authorizations

Path parameters

idOrKeystringrequired

Account ID or Key of the account to add discounted fee rate to

Body

target_fee_ratenumber

Example: 0.05

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.alluvial.finance/v0/platform/accounts/{idOrKey}/discount_rate' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"target_fee_rate":0.05}'

200

400

401

403

404

409

500

{
  "account_id": "36cc991e-d4r5-422c-8248-ac356e800fc1",
  "created_at": "2023-12-31T23:59:59Z",
  "removed_at": "2023-12-31T23:59:59Z",
  "target_fee_rate": 0.05
}

Get the discounted fee rate for an account

get

/v0/platform/accounts/{idOrKey}/discount_rate

Authorizations

Path parameters

idOrKeystringrequired

Account ID or Key of the account to get discount rate for

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.alluvial.finance/v0/platform/accounts/{idOrKey}/discount_rate' \
  --header 'Authorization: Bearer JWT'

200

401

403

404

500

{
  "account_id": "36cc991e-d4r5-422c-8248-ac356e800fc1",
  "created_at": "2023-12-31T23:59:59Z",
  "removed_at": "2023-12-31T23:59:59Z",
  "target_fee_rate": 0.05
}

Update a discounted fee rate for an account

Update a discounted fee rate for an account. If the discount rate already exists, it will be updated. A TargetFeeRate of 0.1 means no discount.

patch

/v0/platform/accounts/{idOrKey}/discount_rate

Authorizations

Path parameters

idOrKeystringrequired

Account ID or Key of the account to update discounted fee rate for

Body

target_fee_ratenumber

Example: 0.05

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.alluvial.finance/v0/platform/accounts/{idOrKey}/discount_rate' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"target_fee_rate":0.05}'

200

304

400

401

403

404

500

{
  "account_id": "36cc991e-d4r5-422c-8248-ac356e800fc1",
  "created_at": "2023-12-31T23:59:59Z",
  "removed_at": "2023-12-31T23:59:59Z",
  "target_fee_rate": 0.05
}