Get a market
curl --request GET \
--url https://{host}/v1/markets/{marketId} \
--header 'Authorization: <api-key>' \
--header 'X-Ambient-Actor: <api-key>' \
--header 'X-Ambient-Timestamp: <api-key>'import requests
url = "https://{host}/v1/markets/{marketId}"
headers = {
"X-Ambient-Actor": "<api-key>",
"X-Ambient-Timestamp": "<api-key>",
"Authorization": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-Ambient-Actor': '<api-key>',
'X-Ambient-Timestamp': '<api-key>',
Authorization: '<api-key>'
}
};
fetch('https://{host}/v1/markets/{marketId}', 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://{host}/v1/markets/{marketId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"X-Ambient-Actor: <api-key>",
"X-Ambient-Timestamp: <api-key>"
],
]);
$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://{host}/v1/markets/{marketId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Ambient-Actor", "<api-key>")
req.Header.Add("X-Ambient-Timestamp", "<api-key>")
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/v1/markets/{marketId}")
.header("X-Ambient-Actor", "<api-key>")
.header("X-Ambient-Timestamp", "<api-key>")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/markets/{marketId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Ambient-Actor"] = '<api-key>'
request["X-Ambient-Timestamp"] = '<api-key>'
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"version": 2,
"state": "draft",
"creator": {
"principalId": "<string>",
"actorId": "<string>",
"authorityRef": "<string>"
},
"subject": {
"schema": "restaurant-table.v1",
"data": {
"partySize": 2,
"startsAt": "2026-09-19T19:00:00Z"
}
},
"mechanism": {
"presetId": "direct-claim.v1",
"config": {
"capacity": 2,
"pricing": {
"mode": "free"
},
"confirmation": "none",
"holdDurationSeconds": -1
}
},
"mechanismState": {
"allocated": 1
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "unauthenticated",
"message": "request authentication failed"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}Markets
Get a market
Returns the current market snapshot to any authenticated actor.
GET
/
v1
/
markets
/
{marketId}
Get a market
curl --request GET \
--url https://{host}/v1/markets/{marketId} \
--header 'Authorization: <api-key>' \
--header 'X-Ambient-Actor: <api-key>' \
--header 'X-Ambient-Timestamp: <api-key>'import requests
url = "https://{host}/v1/markets/{marketId}"
headers = {
"X-Ambient-Actor": "<api-key>",
"X-Ambient-Timestamp": "<api-key>",
"Authorization": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
'X-Ambient-Actor': '<api-key>',
'X-Ambient-Timestamp': '<api-key>',
Authorization: '<api-key>'
}
};
fetch('https://{host}/v1/markets/{marketId}', 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://{host}/v1/markets/{marketId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"X-Ambient-Actor: <api-key>",
"X-Ambient-Timestamp: <api-key>"
],
]);
$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://{host}/v1/markets/{marketId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Ambient-Actor", "<api-key>")
req.Header.Add("X-Ambient-Timestamp", "<api-key>")
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{host}/v1/markets/{marketId}")
.header("X-Ambient-Actor", "<api-key>")
.header("X-Ambient-Timestamp", "<api-key>")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/v1/markets/{marketId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Ambient-Actor"] = '<api-key>'
request["X-Ambient-Timestamp"] = '<api-key>'
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"version": 2,
"state": "draft",
"creator": {
"principalId": "<string>",
"actorId": "<string>",
"authorityRef": "<string>"
},
"subject": {
"schema": "restaurant-table.v1",
"data": {
"partySize": 2,
"startsAt": "2026-09-19T19:00:00Z"
}
},
"mechanism": {
"presetId": "direct-claim.v1",
"config": {
"capacity": 2,
"pricing": {
"mode": "free"
},
"confirmation": "none",
"holdDurationSeconds": -1
}
},
"mechanismState": {
"allocated": 1
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "unauthenticated",
"message": "request authentication failed"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}{
"error": {
"code": "invalid_request",
"message": "<string>"
}
}Authorizations
AmbientActor & AmbientTimestamp & AmbientSignatureAmbientBearer
Provisioned actor identifier.
Current Unix timestamp in seconds, within the configured clock-skew window.
Ambient-HMAC followed by a space and the unpadded base64url HMAC-SHA256 signature. See Authentication and authority for the canonical input.
Path Parameters
Client-selected market identifier.
Minimum string length:
1Response
Current market snapshot.
Minimum string length:
1Monotonically increasing version used for optimistic concurrency.
Required range:
x >= 1Available options:
draft, open, closed Show child attributes
Show child attributes
Show child attributes
Show child attributes
Supported versioned allocation mechanism and its immutable configuration.
- Option 1
- Option 2
Show child attributes
Show child attributes
Public state owned by the selected mechanism.
- Option 1
- Option 2
Show child attributes
Show child attributes