ownership-controller

getOwnershipById

Returns ownership by Id

Request
path Parameters
ownershipId
required
string (OwnershipId)

Ownership Id in format: 'ETHEREUM:${token}:${tokenId}:${owner}'

Example: ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4:71481372648203575558993015318897331386170125774163974705671968549417949069313:0x9e0905eedceb26dbabde0d72b86a4a88e323959a
Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

get/v0.1/ownerships/{ownershipId}
Response samples
application/json
{
  • "id": "ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4:71481372648203575558993015318897331386170125774163974705671968549417949069313:0x9e0905eedceb26dbabde0d72b86a4a88e323959a",
  • "blockchain": "ETHEREUM",
  • "itemId": "ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4:71481372648203575558993015318897331386170125774163974705671968549417949069313",
  • "contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
  • "collection": "ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4",
  • "tokenId": 123456,
  • "owner": "ETHEREUM:0x9E0905eEdCEb26DBaBde0d72B86A4a88E323959a",
  • "value": 123456,
  • "source": "MINT",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastUpdatedAt": "2019-08-24T14:15:22Z",
  • "creators": [ ],
  • "lazyValue": 123456,
  • "pending": [ ],
  • "auction": {
    },
  • "bestSellOrder": {
    },
  • "originOrders": [
    ]
}

getOwnershipsByIds

Returns Ownerships by Ids

Request
Request Body schema: application/json
ids
required
Array of strings (OwnershipId)

List of the Ownerships ids

Responses
200

OK

400

Bad Request

500

Internal Server Error

post/v0.1/ownerships/byIds
Request samples
application/json
{
  • "ids": [
    ]
}
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "ownerships": [ ]
}

getOwnershipsByItem

Returns ownerships by item

Request
query Parameters
itemId
required
string (ItemId)

Item Id, has format ETHEREUM:${token}:${tokenId}

Example: itemId=ETHEREUM:0xee05af952997b4264681c695a72c719fae9502f4:71481372648203575558993015318897331386170125774163974705671968549417949069313
continuation
string

Continuation token from the previous response

size
integer

The number of items to return

Responses
200

OK

400

Bad Request

500

Internal Server Error

get/v0.1/ownerships/byItem
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "ownerships": [ ]
}

search

Complex ownerships search

Request
Request Body schema: application/json
size
required
integer <int32> [ 1 .. 1000 ]
Default: 50

Number of entities returned

continuation
string

Continuation token to paginate ownerships search result

required
object (OwnershipSearchFilter)

Filter for ownerships search query

sort
string (OwnershipSearchSort)
Enum: "LATEST" "EARLIEST" "HIGHEST_SELL" "LOWEST_SELL"
Responses
200

OK

400

Bad Request

500

Internal Server Error

post/v0.1/ownerships/search
Request samples
application/json
{
  • "size": 50,
  • "continuation": "string",
  • "filter": {
    },
  • "sort": "LATEST"
}
Response samples
application/json
{
  • "total": 0,
  • "continuation": "string",
  • "ownerships": [ ]
}