User
Buy Market Depth
Returns the URL of a secure checkout page. The trader pays the full current calendar month at the flat monthly price (priceCents in the status; no partial-month pricing, no tax added). Signing up during the last days of a month — on or after the renewal charge day — also pays next month. The card is saved for automatic renewal. After paying the trader returns to returnPath with ?depth_checkout=success (or =cancelled); the add-on turns on within about a minute. 409 when the add-on is already on (use the renewal endpoint to turn auto-renew back on).
POST
/
v1
/
user
/
addons
/
market-depth
/
checkout
Buy Market Depth
curl --request POST \
--url https://api.hyperprop.com/platform/v1/user/addons/market-depth/checkout \
--header 'Content-Type: application/json' \
--data '
{
"returnPath": "/settings/add-ons"
}
'import requests
url = "https://api.hyperprop.com/platform/v1/user/addons/market-depth/checkout"
payload = { "returnPath": "/settings/add-ons" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({returnPath: '/settings/add-ons'})
};
fetch('https://api.hyperprop.com/platform/v1/user/addons/market-depth/checkout', 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.hyperprop.com/platform/v1/user/addons/market-depth/checkout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'returnPath' => '/settings/add-ons'
]),
CURLOPT_HTTPHEADER => [
"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.hyperprop.com/platform/v1/user/addons/market-depth/checkout"
payload := strings.NewReader("{\n \"returnPath\": \"/settings/add-ons\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.hyperprop.com/platform/v1/user/addons/market-depth/checkout")
.header("Content-Type", "application/json")
.body("{\n \"returnPath\": \"/settings/add-ons\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/user/addons/market-depth/checkout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"returnPath\": \"/settings/add-ons\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"url": "https://checkout.example.com/c/pay/cs_live_a1b2c3"
}
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 409,
"error": "Conflict",
"message": "Resource already exists",
"code": "CONFLICT"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}⌘I
Buy Market Depth
curl --request POST \
--url https://api.hyperprop.com/platform/v1/user/addons/market-depth/checkout \
--header 'Content-Type: application/json' \
--data '
{
"returnPath": "/settings/add-ons"
}
'import requests
url = "https://api.hyperprop.com/platform/v1/user/addons/market-depth/checkout"
payload = { "returnPath": "/settings/add-ons" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({returnPath: '/settings/add-ons'})
};
fetch('https://api.hyperprop.com/platform/v1/user/addons/market-depth/checkout', 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.hyperprop.com/platform/v1/user/addons/market-depth/checkout",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'returnPath' => '/settings/add-ons'
]),
CURLOPT_HTTPHEADER => [
"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.hyperprop.com/platform/v1/user/addons/market-depth/checkout"
payload := strings.NewReader("{\n \"returnPath\": \"/settings/add-ons\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.post("https://api.hyperprop.com/platform/v1/user/addons/market-depth/checkout")
.header("Content-Type", "application/json")
.body("{\n \"returnPath\": \"/settings/add-ons\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/user/addons/market-depth/checkout")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"returnPath\": \"/settings/add-ons\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"url": "https://checkout.example.com/c/pay/cs_live_a1b2c3"
}
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 409,
"error": "Conflict",
"message": "Resource already exists",
"code": "CONFLICT"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}