Get auction bids

curl --request GET \
  --url https://admin.snagsolutions.io/api/auction_bids \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://admin.snagsolutions.io/api/auction_bids', 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://admin.snagsolutions.io/api/auction_bids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://admin.snagsolutions.io/api/auction_bids"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://admin.snagsolutions.io/api/auction_bids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "submitted",
      "auctionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "auctionItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "currencyAddress": "<string>",
      "currencyDecimals": 123,
      "updatedAt": "2023-11-07T05:31:56Z",
      "auctionItem": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "quantity": 123,
        "mintingContractAsset": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "isPhygitalItem": true,
          "tokenId": 123,
          "revealedAt": "2023-11-07T05:31:56Z",
          "shippingPrice": null
        }
      },
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "walletAddress": "<string>"
      },
      "loyaltyCurrency": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "imageUrl": "<string>",
        "apiGetUrl": "<string>",
        "apiGetTransactionEntryUrl": "<string>",
        "apiPostUrl": "<string>",
        "apiAuthType": "none",
        "apiAuthKey": "<string>",
        "apiAuthValue": "<string>"
      },
      "auction": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "amount": null
    }
  ],
  "hasNextPage": true,
  "count": 123
}

"Forbidden, Could not validate api key"

{
  "success": false,
  "message": "Internal server error",
  "debugInfo": "Stack trace or additional error details"
}

GET

api

auction_bids

Get auction bids

curl --request GET \
  --url https://admin.snagsolutions.io/api/auction_bids \
  --header 'X-API-KEY: <api-key>'

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://admin.snagsolutions.io/api/auction_bids', 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://admin.snagsolutions.io/api/auction_bids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://admin.snagsolutions.io/api/auction_bids"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://admin.snagsolutions.io/api/auction_bids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "submitted",
      "auctionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "auctionItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "currencyAddress": "<string>",
      "currencyDecimals": 123,
      "updatedAt": "2023-11-07T05:31:56Z",
      "auctionItem": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "quantity": 123,
        "mintingContractAsset": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "isPhygitalItem": true,
          "tokenId": 123,
          "revealedAt": "2023-11-07T05:31:56Z",
          "shippingPrice": null
        }
      },
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "walletAddress": "<string>"
      },
      "loyaltyCurrency": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "symbol": "<string>",
        "decimals": 123,
        "imageUrl": "<string>",
        "apiGetUrl": "<string>",
        "apiGetTransactionEntryUrl": "<string>",
        "apiPostUrl": "<string>",
        "apiAuthType": "none",
        "apiAuthKey": "<string>",
        "apiAuthValue": "<string>"
      },
      "auction": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      },
      "amount": null
    }
  ],
  "hasNextPage": true,
  "count": 123
}

"Forbidden, Could not validate api key"

{
  "success": false,
  "message": "Internal server error",
  "debugInfo": "Stack trace or additional error details"
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

The bid ID(s) - accepts a single ID or an array of IDs

Example:

"123e4567-e89b-12d3-a456-426614174010"

userId

string<uuid>

ID of the user who made the bid

Example:

"123e4567-e89b-12d3-a456-426614174001"

walletAddress

string

Wallet address of the bidder

Example:

"0x1234567890abcdef1234567890abcdef12345678"

startingAfter

string<uuid>

Pagination cursor to start after a specific bid ID

Example:

"123e4567-e89b-12d3-a456-426614174020"

limit

integer

Maximum number of bids to return

Required range: 1 <= x <= 1000

Example:

50

organizationId

string<uuid>

ID of the organization

Example:

"123e4567-e89b-12d3-a456-426614174002"

websiteId

string<uuid>

ID of the website

Example:

"123e4567-e89b-12d3-a456-426614174003"

auctionId

string<uuid>

ID of the auction

Example:

"123e4567-e89b-12d3-a456-426614174004"

status

enum<string>

Status of the bid

Available options:

submitted,

accepted,

rejected,

fulfilled

Example:

"PENDING"

orderBy

enum<string>

Order bids by amount (ascending or descending). Defaults to desc.

Available options:

asc,

desc

Example:

"desc"

skip

integer | null

Number of bids to skip (for offset-based pagination)

Required range: x >= 0

Example:

1999

includeCount

boolean | null

Include total count of matching bids in response

Example:

true

statuses

enum<string>[]

Filter by multiple bid statuses (OR condition)

Available options:

submitted,

accepted,

rejected,

fulfilled

Example:

["accepted", "fulfilled"]

Response

200

data

Get Auction Bids Response Schema · object[]

required

Show child attributes

hasNextPage

boolean

required

Indicates if there is a next page of results

count

number

Total count of matching bids (only present when includeCount=true)

API Documentation

Asset

Auction

Contract

Identity

Loyalty

Badge

Social Posts

Minting

Question

Stratus

Referrals

Website

Landing Page

Token Claims

Get auction bids

Authorizations

Query Parameters

Response