Create an offer
curl --request POST \
--url https://api.collectpure.com/offers/create-offer/v1 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 4503599627370496,
"expiresAt": "2023-11-07T05:31:56Z",
"price": 4503599627370495,
"premiumPercent": 1,
"premiumDollar": 4503599627370495,
"buyerNotes": "<string>",
"active": true,
"maxSpotPrice": 4503599627370495,
"minSpotPrice": 4503599627370495
}
'import requests
url = "https://api.collectpure.com/offers/create-offer/v1"
payload = {
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 4503599627370496,
"expiresAt": "2023-11-07T05:31:56Z",
"price": 4503599627370495,
"premiumPercent": 1,
"premiumDollar": 4503599627370495,
"buyerNotes": "<string>",
"active": True,
"maxSpotPrice": 4503599627370495,
"minSpotPrice": 4503599627370495
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
variantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity: 4503599627370496,
expiresAt: '2023-11-07T05:31:56Z',
price: 4503599627370495,
premiumPercent: 1,
premiumDollar: 4503599627370495,
buyerNotes: '<string>',
active: true,
maxSpotPrice: 4503599627370495,
minSpotPrice: 4503599627370495
})
};
fetch('https://api.collectpure.com/offers/create-offer/v1', 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.collectpure.com/offers/create-offer/v1",
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([
'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'variantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => 4503599627370496,
'expiresAt' => '2023-11-07T05:31:56Z',
'price' => 4503599627370495,
'premiumPercent' => 1,
'premiumDollar' => 4503599627370495,
'buyerNotes' => '<string>',
'active' => true,
'maxSpotPrice' => 4503599627370495,
'minSpotPrice' => 4503599627370495
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.collectpure.com/offers/create-offer/v1"
payload := strings.NewReader("{\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 4503599627370496,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"price\": 4503599627370495,\n \"premiumPercent\": 1,\n \"premiumDollar\": 4503599627370495,\n \"buyerNotes\": \"<string>\",\n \"active\": true,\n \"maxSpotPrice\": 4503599627370495,\n \"minSpotPrice\": 4503599627370495\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.collectpure.com/offers/create-offer/v1")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 4503599627370496,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"price\": 4503599627370495,\n \"premiumPercent\": 1,\n \"premiumDollar\": 4503599627370495,\n \"buyerNotes\": \"<string>\",\n \"active\": true,\n \"maxSpotPrice\": 4503599627370495,\n \"minSpotPrice\": 4503599627370495\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.collectpure.com/offers/create-offer/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 4503599627370496,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"price\": 4503599627370495,\n \"premiumPercent\": 1,\n \"premiumDollar\": 4503599627370495,\n \"buyerNotes\": \"<string>\",\n \"active\": true,\n \"maxSpotPrice\": 4503599627370495,\n \"minSpotPrice\": 4503599627370495\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 0,
"updatedAt": "<string>",
"expiresAt": "<string>",
"quantity": 0,
"buyerNotes": "<string>",
"createdAt": "<string>",
"premiumPercent": -0.5,
"premiumDollar": 0,
"spotPremium": -0.5,
"active": true,
"spotPremiumDollar": 0,
"maxSpotPrice": 0,
"minSpotPrice": 0,
"expiryNotifiedAt": "<string>"
}
}Offers API
Create an offer
Create a new orderbook offer (bid) for the authenticated organization.
Rate limit: 120 requests burst, 60 requests/minute sustained.
POST
/
offers
/
create-offer
/
v1
Create an offer
curl --request POST \
--url https://api.collectpure.com/offers/create-offer/v1 \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 4503599627370496,
"expiresAt": "2023-11-07T05:31:56Z",
"price": 4503599627370495,
"premiumPercent": 1,
"premiumDollar": 4503599627370495,
"buyerNotes": "<string>",
"active": true,
"maxSpotPrice": 4503599627370495,
"minSpotPrice": 4503599627370495
}
'import requests
url = "https://api.collectpure.com/offers/create-offer/v1"
payload = {
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"quantity": 4503599627370496,
"expiresAt": "2023-11-07T05:31:56Z",
"price": 4503599627370495,
"premiumPercent": 1,
"premiumDollar": 4503599627370495,
"buyerNotes": "<string>",
"active": True,
"maxSpotPrice": 4503599627370495,
"minSpotPrice": 4503599627370495
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
variantId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
quantity: 4503599627370496,
expiresAt: '2023-11-07T05:31:56Z',
price: 4503599627370495,
premiumPercent: 1,
premiumDollar: 4503599627370495,
buyerNotes: '<string>',
active: true,
maxSpotPrice: 4503599627370495,
minSpotPrice: 4503599627370495
})
};
fetch('https://api.collectpure.com/offers/create-offer/v1', 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.collectpure.com/offers/create-offer/v1",
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([
'productId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'variantId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'quantity' => 4503599627370496,
'expiresAt' => '2023-11-07T05:31:56Z',
'price' => 4503599627370495,
'premiumPercent' => 1,
'premiumDollar' => 4503599627370495,
'buyerNotes' => '<string>',
'active' => true,
'maxSpotPrice' => 4503599627370495,
'minSpotPrice' => 4503599627370495
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.collectpure.com/offers/create-offer/v1"
payload := strings.NewReader("{\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 4503599627370496,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"price\": 4503599627370495,\n \"premiumPercent\": 1,\n \"premiumDollar\": 4503599627370495,\n \"buyerNotes\": \"<string>\",\n \"active\": true,\n \"maxSpotPrice\": 4503599627370495,\n \"minSpotPrice\": 4503599627370495\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.collectpure.com/offers/create-offer/v1")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 4503599627370496,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"price\": 4503599627370495,\n \"premiumPercent\": 1,\n \"premiumDollar\": 4503599627370495,\n \"buyerNotes\": \"<string>\",\n \"active\": true,\n \"maxSpotPrice\": 4503599627370495,\n \"minSpotPrice\": 4503599627370495\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.collectpure.com/offers/create-offer/v1")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"variantId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"quantity\": 4503599627370496,\n \"expiresAt\": \"2023-11-07T05:31:56Z\",\n \"price\": 4503599627370495,\n \"premiumPercent\": 1,\n \"premiumDollar\": 4503599627370495,\n \"buyerNotes\": \"<string>\",\n \"active\": true,\n \"maxSpotPrice\": 4503599627370495,\n \"minSpotPrice\": 4503599627370495\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"price": 0,
"updatedAt": "<string>",
"expiresAt": "<string>",
"quantity": 0,
"buyerNotes": "<string>",
"createdAt": "<string>",
"premiumPercent": -0.5,
"premiumDollar": 0,
"spotPremium": -0.5,
"active": true,
"spotPremiumDollar": 0,
"maxSpotPrice": 0,
"minSpotPrice": 0,
"expiryNotifiedAt": "<string>"
}
}Authorizations
API key for authentication
Body
application/json
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Required range:
1 <= x <= 9007199254740991Available options:
fixed_pricing, premium_percentage_pricing, premium_dollar_pricing Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Price in cents. Required for fixed_pricing type
Required range:
0 < x <= 9007199254740991Required range:
x >= 0Premium in cents
Required range:
0 <= x <= 9007199254740991Maximum string length:
500Max spot price in cents
Required range:
0 < x <= 9007199254740991Min spot price in cents
Required range:
0 < x <= 9007199254740991Was this page helpful?
⌘I