Broker
Set a client's tier
Put a client organization on a pre-agreed sub-org tier, or take it off one.
Name the client with the Nxos-On-Behalf-Of header. Unlike other cross-org
endpoints, holding an LOA is not sufficient here: you may only set the tier
of an organization you created via POST /v1/organizations. This stops
a customer repricing itself while acting on its own behalf.
You can price a client from the moment you create them — verification does not need to have completed.
Assign a tier at any time after the client is created — pricing takes effect on their next quote, and on the commission you earn from their next trade. Trades already executed are unaffected.
Pass subOrgTierKey: null to remove the tier and return the client to default
pricing. List the tiers you may assign with GET /v1/sub-org-tiers.
PUT
/
v1
/
organizations
/
sub-org-tier
cURL
curl --request PUT \
--url https://api.nxos.io/v1/organizations/sub-org-tier \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"subOrgTierKey": "<string>"
}
'import requests
url = "https://api.nxos.io/v1/organizations/sub-org-tier"
payload = { "subOrgTierKey": "<string>" }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({subOrgTierKey: '<string>'})
};
fetch('https://api.nxos.io/v1/organizations/sub-org-tier', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nxos.io/v1/organizations/sub-org-tier",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'subOrgTierKey' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.nxos.io/v1/organizations/sub-org-tier"
payload := strings.NewReader("{\n \"subOrgTierKey\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.nxos.io/v1/organizations/sub-org-tier")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"subOrgTierKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nxos.io/v1/organizations/sub-org-tier")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subOrgTierKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"object": "sub_org_tier_assignment",
"organizationId": "<string>",
"tier": {
"key": "<string>",
"label": "<string>",
"spreadBps": 123,
"referrerShareBps": 123
}
}{
"error": {
"code": "missing_api_key",
"message": "No Authorization header provided.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "forbidden",
"message": "Your organization is not enabled for this action.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "not_found",
"message": "The requested resource was not found.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "validation_error",
"message": "Request body failed validation.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded: 1000 requests per minute. Retry in 23 seconds.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "internal_error",
"message": "An unexpected server error occurred.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}Headers
Bearer token. Format: Bearer <api_key>
Body
application/json
Request body for PUT /v1/organizations/sub-org-tier.
Key of the tier to assign, from GET /v1/sub-org-tiers. Pass null (or
omit) to remove the organization's tier, dropping it back to default
pricing.
Response
The request has succeeded.
Result of setting or clearing an organization's sub-org tier.
⌘I
cURL
curl --request PUT \
--url https://api.nxos.io/v1/organizations/sub-org-tier \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"subOrgTierKey": "<string>"
}
'import requests
url = "https://api.nxos.io/v1/organizations/sub-org-tier"
payload = { "subOrgTierKey": "<string>" }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({subOrgTierKey: '<string>'})
};
fetch('https://api.nxos.io/v1/organizations/sub-org-tier', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.nxos.io/v1/organizations/sub-org-tier",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'subOrgTierKey' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.nxos.io/v1/organizations/sub-org-tier"
payload := strings.NewReader("{\n \"subOrgTierKey\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.nxos.io/v1/organizations/sub-org-tier")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"subOrgTierKey\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nxos.io/v1/organizations/sub-org-tier")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"subOrgTierKey\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"object": "sub_org_tier_assignment",
"organizationId": "<string>",
"tier": {
"key": "<string>",
"label": "<string>",
"spreadBps": 123,
"referrerShareBps": 123
}
}{
"error": {
"code": "missing_api_key",
"message": "No Authorization header provided.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "forbidden",
"message": "Your organization is not enabled for this action.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "not_found",
"message": "The requested resource was not found.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "validation_error",
"message": "Request body failed validation.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded: 1000 requests per minute. Retry in 23 seconds.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}{
"error": {
"code": "internal_error",
"message": "An unexpected server error occurred.",
"requestId": "req_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"
}
}