Inventory

The Inventory API provides a comprehensive set of endpoints to interact with inventories.

Retrieve an inventory

get
Path parameters
ckeystringRequired
Responses
400

Generic Client Error

application/json
get
/v1/community/{ckey}/inventory
GET /v1/community/{ckey}/inventory HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Return the slots of an inventory

get
Path parameters
ckeystringRequired
Query parameters
userIdstringRequired
Responses
400

Generic Client Error

application/json
get
/v1/community/{ckey}/inventory/slots
GET /v1/community/{ckey}/inventory/slots?userId=text HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Return list of items of a slot

get
Path parameters
ckeystringRequired
slotIdstringRequired
Query parameters
pagenumberOptional
limitnumberOptional
onlyOwnedstringRequired
Responses
400

Generic Client Error

application/json
get
/v1/community/{ckey}/inventory/slots/{slotId}/items
GET /v1/community/{ckey}/inventory/slots/{slotId}/items?onlyOwned=text HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Return item

get
Path parameters
ckeystringRequired
itemIdstringRequired
Responses
400

Generic Client Error

application/json
get
/v1/community/{ckey}/inventory/items/{itemId}
GET /v1/community/{ckey}/inventory/items/{itemId} HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Allocate slots of an inventory to a user

post
Path parameters
ckeystringRequired
Body
Responses
201Success
No content
post
/v1/community/{ckey}/inventory/slots/allocate
POST /v1/community/{ckey}/inventory/slots/allocate HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "slots": [
    {
      "slotId": "text",
      "itemId": "text"
    }
  ]
}
No content

Return the avatar of an user from an inventory

get
Path parameters
ckeystringRequired
Query parameters
userIdstringRequired
Responses
400

Generic Client Error

application/json
get
/v1/community/{ckey}/inventory/avatar
GET /v1/community/{ckey}/inventory/avatar?userId=text HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Return inventory items

get
Path parameters
ckeystringRequired
Query parameters
pagenumberOptional
limitnumberOptional
onlyOwnedstringRequired
userIdstringRequired
Responses
400

Generic Client Error

application/json
get
/v1/community/{ckey}/inventory/items
GET /v1/community/{ckey}/inventory/items?onlyOwned=text&userId=text HTTP/1.1
Host: 
Accept: */*

{
  "code": 10002,
  "message": "generic_client_error"
}

Mint the Avatar of user as an NFT on a blockchain

post
Path parameters
ckeystringRequired
Body
blockchainstringRequired
Responses
201Success
No content
post
/v1/community/{ckey}/inventory/avatar/mint
POST /v1/community/{ckey}/inventory/avatar/mint HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "blockchain": "text"
}
No content

PreviousResourcesNextPrizes

Last updated