ALalpacahq
FPSL Program

List FPSL Tiers

List all available FPSL tiers. These tiers may be assigned to an account.

get/v1/fpsl/tiers

Request

  • Base URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets
  • URL
    https://broker-api.giftcity.sandbox.in.alpaca.markets/v1/fpsl/tiers
  • Auth
    HTTP basic

Response

Successful response, returns a list of FPSL tiers or none if no tiers are available.

created_atstring date-time

The timestamp the FPSL tier was created, in RFC 3339 format.

customer_splitnumber

Percentage of the customer split represented as a value between 0 and 1.00. Max 2 decimal places are allowed.

idstring uuid

The unique identifier of the FPSL tier

marketstring

The market of the FPSL tier

partner_splitnumber

Percentage of the partner split represented as a value between 0 and 1.00. Max 2 decimal places are allowed.

tier_namestring

The name of the FPSL tier

updated_atstring date-time

The timestamp of the last update to the FPSL tier, in RFC 3339 format.

Example response

[
  {
    "created_at": "2024-09-16T20:06:32.207729Z",
    "customer_split": 0.25,
    "id": "150df7eb-31e7-46b3-8848-a54ca21ff3bc",
    "market": "US",
    "partner_split": 0.3,
    "tier_name": "gold",
    "updated_at": "2024-09-16T20:06:32.207729Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.