These are authenticated endpoints. You can visit authentication to get an access token.
These endpoints allow you to manage profiles. They are the users of the auction house and are the owners of listings.
These endpoints support pagination and sorting. Read more about these features here .
Prop Type Default string
- string
- string
- integer
- Array<string>
- -
Not all of the properties of a post are returned by default. You can use the following optional query parameters to include additional properties in the response.
Prop Type Default boolean
false
Example with all optional query parameters { "name" : "string" , "email" : "user@example.com" , "avatar" : "https://url.com/image.jpg" , "credits" : 0 , "wins" : [ "string" ], "listings" : [ { "id" : "string" , "title" : "string" , "description" : "string" , "media" : [ "https://url.com/image.jpg" ], "created" : "2020-01-01T00:00:00.000Z" , "updated" : "2020-01-01T00:00:00.000Z" , "endsAt" : "2020-01-01T00:00:00.000Z" } ], "_count" : { "listings" : 0 } } GET /auction/profiles
Retrieve all profiles.
[ { "name" : "string" , "email" : "user@example.com" , "avatar" : "https://url.com/image.jpg" , "credits" : 0 , "wins" : [ "string" ], "_count" : { "listings" : 0 } }, { "name" : "string" , "email" : "user@example.com" , "avatar" : "https://url.com/image.jpg" , "credits" : 0 , "wins" : [ "string" ], "_count" : { "listings" : 0 } } ] GET /auction/profiles/<name>
Retrieve a single profile by its id.
{ "name" : "string" , "email" : "user@example.com" , "avatar" : "https://url.com/image.jpg" , "credits" : 0 , "wins" : [ "string" ], "_count" : { "listings" : 0 } } PUT /auction/profiles/<name>/media
Update or set profile avatar image.
Remove the avatar by setting the property to null.
Please note that profile avatar property must be a fully formed URL that links to a live and publicly accessible image. The API will check the provided URL and if it cannot be accessed publicly you will receive a 400 error response.
{ "avatar" : "https://url.com/image.jpg" // Required } { "name" : "string" , "email" : "user@example.com" , "avatar" : "https://url.com/image.jpg" , "credits" : 0 , "wins" : [ "string" ], "_count" : { "listings" : 0 } } GET /auction/profiles/<name>/listings
Retrieve all listings created by profile.
The response is the same as the listings endpoint, and accepts the same optional query parameters and flags.
[ { "id" : "string" , "title" : "string" , "description" : "string" , "media" : [ "https://url.com/image.jpg" ], "tags" : [ "string" ], "created" : "2020-01-01T00:00:00.000Z" , "updated" : "2020-01-01T00:00:00.000Z" , "endsAt" : "2020-01-01T00:00:00.000Z" , "_count" : { "bids" : 0 } }, { "id" : "string" , "title" : "string" , "description" : "string" , "media" : [ "https://url.com/image.jpg" ], "tags" : [ "string" ], "created" : "2020-01-01T00:00:00.000Z" , "updated" : "2020-01-01T00:00:00.000Z" , "endsAt" : "2020-01-01T00:00:00.000Z" , "_count" : { "bids" : 0 } } // ... ] GET /auction/profiles/<name>/bids
Retrieve all bids made by profile.
Use the _listing flag to include the associated listing's data.
[ { "id" : "string" , "amount" : 0 , "bidderName" : "string" , "created" : "2020-01-01T00:00:00.000Z" }, { "id" : "string" , "amount" : 0 , "bidderName" : "string" , "created" : "2020-01-01T00:00:00.000Z" } // ... ] 