API reference / Collectors

Account

3 operations.

GET/api/v1/me/deletion

What deleting your account does

Signed in

What it removes, what it keeps (anonymized) and which shops change hands, for the confirmation.

SDK: collector.previewAccountDeletion()
Key scopes: account:read(API keys are coming soon)
Headers: If-None-MatchX-Request-Id

Responses

200The preview.
AccountDeletionPreview
What deleting the account removes, keeps and hands over.
- emailstring or nullrequired
- usernamestring or nullrequired
- copiesobjectrequired
  Fields of copies
  ownedintegerrequired
  wishlistintegerrequired
  soldintegerrequired
- photosintegerrequired
- scansintegerrequired
- filesintegerrequired
- marketObservationsintegerrequired
  Anonymized purchase and sale prices contributed while sharing was on.
- shareMarketDatabooleanrequired
- subscriptionobject or nullrequired
  Fields of subscription
  planstringrequired
  statusstringrequired
  renewsstring (date-time) or nullrequired
- storesarray of objectrequired
  Shops the collector owns and what happens to each.
  Fields of stores
  idstring (uuid)required
  namestringrequired
  outcomeenumrequired
  One oftransferclosekeeps_other_owner
  heirstring or nullrequired
- openHoldsintegerrequired
- completedSalesintegerrequired
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (401, 500)

401unauthorized
unauthorized: Not signed in (no session or token, or an expired one).
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/me/deletion' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN"

TypeScript SDK

await collector.previewAccountDeletion();

POST/api/v1/me/deletion

Delete your account

Signed in

Deletes the signed-in account. Confirm with { "confirmation": "DELETE" }; nothing in the body names an account.

SDK: collector.deleteMyAccount()
Key scopes: account:delete(API keys are coming soon)
Headers: X-Request-Id

Request body (required, application/json)

object

confirmationstringrequired
Type DELETE to confirm.
removeMarketDatabooleanoptionaldefault false
Also remove the anonymized prices this account contributed (kept by default, without anything that identifies you).

Responses

200Deleted.
AccountDeletionResult
The account is gone.
- deleted"true"required
- observationsKeptintegerrequired
- observationsRemovedintegerrequired
- filesRemovedintegerrequired

Errors (400, 401, 500)

400invalid_request invalid_json confirmation_required
invalid_request: The query or body doesn’t match the schema (see errors[]).
invalid_json: The body isn’t JSON.
confirmation_required: Type DELETE to confirm.
401unauthorized
unauthorized: Not signed in (no session or token, or an expired one).
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl -X POST 'https://collection.id/api/v1/me/deletion' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN" \
  -H 'Content-Type: application/json' \
  -d @body.json

TypeScript SDK

await collector.deleteMyAccount({ body: { … } });

PATCH/api/v1/me/profile

Update your profile

Signed in

Profile and privacy settings. Only the fields sent change. A public profile needs a username (its address).

SDK: collector.updateMyProfile()
Key scopes: account:write(API keys are coming soon)
Headers: X-Request-Id

Request body (required, application/json)

object

usernamestring or nulloptionalat most 80 characters
The public profile’s address; null or empty clears it.
display_namestring or nulloptionalat most 160 characters
biostring or nulloptionalat most 1200 characters
locationstring or nulloptionalat most 160 characters
websitestring or nulloptionalat most 400 characters
An http(s) link.
avatar_pathstring or nulloptionalat most 512 characters
A file you uploaded to the avatars bucket: <your id>/<name>.webp|jpg|png.
is_publicbooleanoptional
show_valuesbooleanoptional
show_wishlistbooleanoptional
share_market_databooleanoptional
share_usage_statsbooleanoptional
Count this collector in first-party usage statistics; off deletes what was recorded.
preferred_currencyenumoptional
The currency prices are recorded and totals shown in.
One ofUSDCADGBPEURAUDNZD
onboarded"true"optional
First-run onboarding finished or skipped.

Responses

200The profile as saved.
object
- profileProfile or nullrequired
  Null only if the profile vanished mid-request.

Errors (400, 401, 404, 500)

400invalid_request invalid_json
invalid_request: The query or body doesn’t match the schema (see errors[]).
invalid_json: The body isn’t JSON.
401unauthorized
unauthorized: Not signed in (no session or token, or an expired one).
404not_found
not_found: The profile doesn’t exist.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl -X PATCH 'https://collection.id/api/v1/me/profile' \
  -H "Authorization: Bearer $COLLECTOR_TOKEN" \
  -H 'Content-Type: application/json' \
  -d @body.json

TypeScript SDK

await collector.updateMyProfile({ body: { … } });