mallow docs

Offers inbox

POST
/v2/offers/inbox

Every ACTIVE offer and auction bid the owners wallets are involved in, received and placed, merged into one sorted feed. Offers are active when they have no endTime or it is still in the future; bids are included when the auction has started and is either live or complete-but-unsettled.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Wallets + paging for the aggregated inbox. owners is array-only (no path param) because the wallet unions the active session wallets into one feed.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v2/offers/inbox" \  -H "Content-Type: application/json" \  -d '{    "owners": [      "string"    ],    "sort": "latest",    "page": 0  }'
{  "result": {    "result": [      {        "kind": "offer",        "direction": "received",        "asset": "string",        "artworkTitle": "string",        "artworkImageUrl": "string",        "nsfw": true,        "editionNumber": 0,        "creatorUsername": "string",        "actorAddress": "string",        "actor": {          "username": "string",          "displayName": "string",          "imageUrl": "string"        },        "viewerAddress": "string",        "rawAmount": "string",        "currencyMint": "string",        "usdValue": 0,        "date": "string",        "endTime": "string",        "txId": "string",        "auction": {          "status": "live",          "settled": true,          "endTime": "string",          "sellerAddress": "string",          "isHighestBidder": true,          "highestBid": {            "bidderAddress": "string",            "bidder": {              "username": "string",              "displayName": "string",              "imageUrl": "string"            },            "rawAmount": "string",            "currencyMint": "string",            "usdValue": 0,            "date": "string",            "txId": "string"          },          "yourBid": {            "bidderAddress": "string",            "bidder": {              "username": "string",              "displayName": "string",              "imageUrl": "string"            },            "rawAmount": "string",            "currencyMint": "string",            "usdValue": 0,            "date": "string",            "txId": "string"          },          "recentBids": [            {              "bidderAddress": "string",              "bidder": {                "username": "string",                "displayName": "string",                "imageUrl": "string"              },              "rawAmount": "string",              "currencyMint": "string",              "usdValue": 0,              "date": "string",              "txId": "string"            }          ]        }      }    ],    "nextPage": 0,    "total": 0,    "hiddenByBlockCount": 0  }}