ownership-controller

getOwnershipById

Returns ownership by Id

Request

path Parameters

ownershipId

required

string (OwnershipId)

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

Example: ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410:0x4765273c477c2dc484da4f1984639e943adccfeb

Responses

200

400

Bad Request

404

Not Found

500

Internal Server Error

get/v0.1/ownerships/{ownershipId}

Response samples

application/json

{"id": "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410:0x4765273c477c2dc484da4f1984639e943adccfeb",
"blockchain": "ETHEREUM",
"itemId": "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"collection": "ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8",
"tokenId": 123456,
"owner": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"value": 123456,
"source": "MINT",
"createdAt": "2019-08-24T14:15:22Z",
"lastUpdatedAt": "2019-08-24T14:15:22Z",
"creators": [ ],
"lazyValue": 123456,
"pending": [ ],
"auction": {"id": "ETHEREUM:${id}",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"type": "RARIBLE_AUCTION_V1",
"seller": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"sell": {"type": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"value": 123456.789
},
"buy": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"endTime": "2019-08-24T14:15:22Z",
"minimalStep": 123456.789,
"minimalPrice": 123456.789,
"createdAt": "2019-08-24T14:15:22Z",
"lastUpdateAt": "2019-08-24T14:15:22Z",
"buyPrice": 123456.789,
"buyPriceUsd": 123456.789,
"pending": [{"hash": "string"
}
],
"status": "ACTIVE",
"ongoing": true,
"hash": "string",
"auctionId": 123456,
"lastBid": {"buyer": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"amount": 123456.789,
"date": "2019-08-24T14:15:22Z",
"status": "ACTIVE",
"type": "RARIBLE_AUCTION_V1_BID_V1",
"data": {"dataType": "RARIBLE_AUCTION_V1_BID_DATA_V1",
"originFees": [{"account": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"value": 0
}
],
"payouts": [{"account": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"value": 0
}
]
}
},
"data": {"dataType": "RARIBLE_AUCTION_V1_DATA_V1",
"originFees": [{"account": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"value": 0
}
],
"payouts": [{"account": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"value": 0
}
],
"startTime": "2019-08-24T14:15:22Z",
"duration": 123456,
"buyOutPrice": 123456.789
}
},
"bestSellOrder": {"id": "ETHEREUM:0x19f487016770542dc6137b06499a4f7b42c9580f12d85d6347964b03b7682143",
"fill": 123456.789,
"platform": "RARIBLE",
"status": "ACTIVE",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"makeStock": 123456.789,
"cancelled": true,
"optionalRoyalties": false,
"createdAt": "2019-08-24T14:15:22Z",
"lastUpdatedAt": "2019-08-24T14:15:22Z",
"dbUpdatedAt": "2019-08-24T14:15:22Z",
"makePrice": 123456.789,
"takePrice": 123456.789,
"makePriceUsd": 123456.789,
"takePriceUsd": 123456.789,
"maker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"taker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"make": {"type": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"value": 123456.789
},
"take": {"type": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"value": 123456.789
},
"salt": "string",
"signature": "string",
"pending": [ ],
"data": {"@type": "ETH_RARIBLE_V1",
"fee": 123456
}
},
"originOrders": [{"origin": "string",
"bestSellOrder": {"id": "ETHEREUM:0x19f487016770542dc6137b06499a4f7b42c9580f12d85d6347964b03b7682143",
"fill": 123456.789,
"platform": "RARIBLE",
"status": "ACTIVE",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"makeStock": 123456.789,
"cancelled": true,
"optionalRoyalties": false,
"createdAt": "2019-08-24T14:15:22Z",
"lastUpdatedAt": "2019-08-24T14:15:22Z",
"dbUpdatedAt": "2019-08-24T14:15:22Z",
"makePrice": 123456.789,
"takePrice": 123456.789,
"makePriceUsd": 123456.789,
"takePriceUsd": 123456.789,
"maker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"taker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"make": {"type": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"value": 123456.789
},
"take": {"type": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"value": 123456.789
},
"salt": "string",
"signature": "string",
"pending": [ ],
"data": {"@type": "ETH_RARIBLE_V1",
"fee": 123456
}
},
"bestBidOrder": {"id": "ETHEREUM:0x19f487016770542dc6137b06499a4f7b42c9580f12d85d6347964b03b7682143",
"fill": 123456.789,
"platform": "RARIBLE",
"status": "ACTIVE",
"startedAt": "2019-08-24T14:15:22Z",
"endedAt": "2019-08-24T14:15:22Z",
"makeStock": 123456.789,
"cancelled": true,
"optionalRoyalties": false,
"createdAt": "2019-08-24T14:15:22Z",
"lastUpdatedAt": "2019-08-24T14:15:22Z",
"dbUpdatedAt": "2019-08-24T14:15:22Z",
"makePrice": 123456.789,
"takePrice": 123456.789,
"makePriceUsd": 123456.789,
"takePriceUsd": 123456.789,
"maker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"taker": "ETHEREUM:0x4765273c477c2dc484da4f1984639e943adccfeb",
"make": {"type": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"value": 123456.789
},
"take": {"type": {"@type": "FLOW_NFT",
"contract": "ETHEREUM:0xd07dc4262bcdbf85190c01c996b4c06a461d2430",
"tokenId": 123456
},
"value": 123456.789
},
"salt": "string",
"signature": "string",
"pending": [ ],
"data": {"@type": "ETH_RARIBLE_V1",
"fee": 123456
}
}
}
]
}

getOwnershipsByIds

Returns Ownerships by Ids

Request

Request Body schema: application/json

ids

required

Array of strings (OwnershipId)

List of the Ownerships ids

Responses

200

400

Bad Request

500

Internal Server Error

post/v0.1/ownerships/byIds

Request samples

Payload

application/json

{"ids": ["ETHEREUM:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410:0x4765273c477c2dc484da4f1984639e943adccfeb"
]
}

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:0xb66a603f4cfe17e3d27b87a8bfcad319856518b8:32292934596187112148346015918544186536963932779440027682601542850818403729410
continuation	string Continuation token from the previous response
size	integer The number of items to return

Responses

200

400

Bad Request

500

Internal Server Error

get/v0.1/ownerships/byItem

Response samples

application/json

{"total": 0,
"continuation": "string",
"ownerships": [ ]
}

searchOwnerships

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

400

Bad Request

500

Internal Server Error

post/v0.1/ownerships/search

Request samples

Payload

application/json

{"size": 10,
"filter": {"blockchains": ["ETHEREUM"
],
"deleted": false,
"sellPriceFrom": 0,
"sellPriceTo": 100,
"sellCurrency": "ETHEREUM:0x0000000000000000000000000000000000000000",
"lastUpdatedAtFrom": "2022-12-01T00:00:00Z",
"lastUpdatedAtTo": "2029-12-01T00:00:00Z"
},
"sort": "EARLIEST"
}

Response samples

application/json

{"total": 0,
"continuation": "string",
"ownerships": [ ]
}

➔ Next to order-controller