Get brokerage firm
curl --request GET \
--url https://api.example.com/brokerage-firms/{brokerageFirmId}import requests
url = "https://api.example.com/brokerage-firms/{brokerageFirmId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/brokerage-firms/{brokerageFirmId}', 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.example.com/brokerage-firms/{brokerageFirmId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/brokerage-firms/{brokerageFirmId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/brokerage-firms/{brokerageFirmId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/brokerage-firms/{brokerageFirmId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"type": "<string>",
"id": "<string>",
"companyInfo": {
"siret": "<string>",
"siren": "<string>",
"nafCode": "<string>",
"nafLabel": "<string>",
"name": "<string>",
"creationDate": "<string>",
"location": {
"city": "<string>",
"country": "<string>",
"address": "<string>",
"postCode": "<string>"
},
"legalStatus": {
"1": "<string>",
"2": "<string>",
"3": "<string>"
},
"headcount": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"tenantId": "<string>",
"activeProducts": [
"<string>"
],
"inactiveProducts": [
"<string>"
],
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"parentBrokerageFirmId": "<string>",
"preferredPaymentMethodId": "<string>"
}{
"title": "BROKERAGE_FIRM_NOT_FOUND"
}brokerage-firms
Get brokerage firm
Retrieves a brokerage firm by id including configuration and metadata.
GET
/
brokerage-firms
/
{brokerageFirmId}
Get brokerage firm
curl --request GET \
--url https://api.example.com/brokerage-firms/{brokerageFirmId}import requests
url = "https://api.example.com/brokerage-firms/{brokerageFirmId}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/brokerage-firms/{brokerageFirmId}', 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.example.com/brokerage-firms/{brokerageFirmId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/brokerage-firms/{brokerageFirmId}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/brokerage-firms/{brokerageFirmId}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/brokerage-firms/{brokerageFirmId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"type": "<string>",
"id": "<string>",
"companyInfo": {
"siret": "<string>",
"siren": "<string>",
"nafCode": "<string>",
"nafLabel": "<string>",
"name": "<string>",
"creationDate": "<string>",
"location": {
"city": "<string>",
"country": "<string>",
"address": "<string>",
"postCode": "<string>"
},
"legalStatus": {
"1": "<string>",
"2": "<string>",
"3": "<string>"
},
"headcount": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"tenantId": "<string>",
"activeProducts": [
"<string>"
],
"inactiveProducts": [
"<string>"
],
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"parentBrokerageFirmId": "<string>",
"preferredPaymentMethodId": "<string>"
}{
"title": "BROKERAGE_FIRM_NOT_FOUND"
}Path Parameters
Brokerage firm id
Response
Brokerage firm retrieved successfully.
Entity type
Brokerage firm type
Available options:
WHOLESALE, RETAIL, TEAM Brokerage firm id
Company info
Show child attributes
Show child attributes
Creation date of brokerage firm
Tenant id
Active products
Inactive products
custom fields per product
Show child attributes
Show child attributes
Brokerage firm id
Was this page helpful?
⌘I

