Aura Historia

Add a listing to the signed-in user's watchlist by productListingId so they can follow it and, with notifications on (the default), hear about changes. A listing already on the watchlist returns CONFLICT; subscription tier limits apply.

Save a new private address with a label and its location in the signed-in user's address book; Aura Historia resolves the location for shipping estimates. Each call creates a new address, so repeating a call that timed out can create a duplicate.

Save a listing search for the signed-in user. Aura Historia matches new listings against it in the background and, with notifications on (the default), notifies the user, so matches appear later. Subscription tier limits apply. Each call creates a new saved search, so repeating a call that timed out can create a duplicate. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents.

Permanently delete one of the signed-in user's notifications by notificationId. Returns an empty object; an unknown ID returns NOT_FOUND.

Permanently delete every notification of the signed-in user, including those beyond the listed page. Takes no arguments. Returns an empty object.

Permanently delete one of the signed-in user's saved addresses. expectedVersion must equal its current version. If the address is the browsing destination, that destination is cleared too. Returns an empty object.

Permanently delete one of the signed-in user's saved searches. Returns an empty object; an unknown ID returns NOT_FOUND.

Remove a listing from the signed-in user's watchlist by productListingId. Returns an empty object; a listing that is not on the watchlist returns NOT_FOUND, also after an earlier call removed it.

Get one auction by its auctionId: name, provider, format, schedule, reported status, reported and visible lot counts, and the link to its catalogue at the provider.

List the lots of one auction by its auctionId in catalogue order, as listings in the requested language and currency with shipping details. Pass the returned searchAfter object as a JSON string to get the next page. For a signed-in user, each result also carries userState sections for which the token has the read scope: watchlist:read, search-filters:read, notifications:read or users:read. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents.

Get the destination Aura Historia uses to estimate shipping while the signed-in user browses: NONE, one of their saved addresses (ADDRESS) or a country with an optional postal code (COUNTRY_POSTAL), with its version.

Get the full details of one listing by its productListingId: text, prices, images, provider, availability, auction and shipping, in the requested language and currency. Use it when the user wants more than a search result shows. For a signed-in user, each result also carries userState sections for which the token has the read scope: watchlist:read, search-filters:read, notifications:read or users:read. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents.

Get the full details of one listing by its productListingTitleSlugId, the last segment of an Aura Historia listing page URL (/products/{slug}). Returns the same details as the lookup by productListingId. For a signed-in user, each result also carries userState sections for which the token has the read scope: watchlist:read, search-filters:read, notifications:read or users:read. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents.

Get the complete history of one listing by its productListingId: when it was first seen and every recorded change, in event order. Use it for questions about price development or past changes. With currency, each price is also converted at the exchange rate of its event. Returns every event in one result; a history too large for one response fails instead of being truncated. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents.

Get the public profile of one provider (a dealer, auction house, marketplace or auction platform) by its listingSourceSlugId, the last segment of an Aura Historia provider page URL (/shops/{slug}): name, operator, website and image.

Get the latest calculated statistics of the Aura Historia catalogue: live listings, listings added in the last seven days, countries, languages and indexed providers by type, with the time they were calculated. Takes no arguments.

Find listings similar to one listing, identified by its productListingId. Returns up to `size` neighbours (default 20; values outside 1 to 50 are clamped) in the requested language and currency. EMBEDDING_PENDING means the listing is not yet prepared for comparison and a later call can succeed; READY with an empty list means nothing similar was found. For a signed-in user, each result also carries userState sections for which the token has the read scope: watchlist:read, search-filters:read, notifications:read or users:read. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents.

Get the signed-in user's Aura Historia account: email, name, language, currency and measurement unit, content preference, marketing consent, subscription tier and role.

Get one of the signed-in user's saved addresses by addressId, with its resolved location and the attribution of the geocoding provider.

Get one of the signed-in user's saved searches by userSearchFilterId, with its criteria, state and notification settings. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents.

List all of the signed-in user's saved searches with their criteria, state and notification settings. Takes no arguments. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents.

List the listings on the signed-in user's watchlist with their full details and notification settings, in the requested language and currency. Pass the returned searchAfter array as a JSON string to get the next page. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents.

List auctions of the auction houses and platforms that Aura Historia indexes, filtered by provider, format, reported status and schedule period and sorted by creation or schedule time. Use it to find upcoming, running or past auctions. A schedule period needs timeRole, from and to together, and sorting by schedule time needs timeRole. Pass the returned searchAfter object as a JSON string to get the next page.

List the signed-in user's notifications, such as watchlist changes and new saved-search matches, with each listing as it was when notified, in the requested language. Returns up to size notifications (default 21, 1 to 100); pass the returned searchAfter array as a JSON string to get the next page. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents.

List the listings that matched one of the signed-in user's saved searches, oldest match first, in the requested language and currency. Matching runs in the background, so an empty first page means there are no matches yet. Returns up to size matches (default 21, 1 to 100); pass the returned searchAfter array unchanged to get the next page. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents.

List the signed-in user's saved addresses with their resolved locations. Returns up to limit addresses (default 25, 1 to 100); pass the returned next as after to get the next page.

Turn notifications for a watched listing on or off, or pause (INACTIVE_BY_USER) or resume (ACTIVE) the entry. Omitted fields stay unchanged and null is invalid; resuming is subject to subscription tier limits. Returns the listing with its full details in the requested language and currency. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents.

Search the providers whose listings Aura Historia indexes (dealers, auction houses, marketplaces and auction platforms) by name. Without a query it browses all providers; a query too short to match returns no results. Returns 1 to 50 providers per page (default 21); pass the returned searchAfter unchanged, with the same query and size, to get the next page.

Set or clear the destination used to estimate shipping while the signed-in user browses: NONE clears it, ADDRESS selects one of their saved addresses and COUNTRY_POSTAL a country with an optional postal code. expectedVersion must equal the current version. Returns the new destination and version.

Search Aura Historia's index of art, antiques and design objects listed by dealers, auction houses, marketplaces and auction platforms. Use it to find listings by text and by filters such as price, dates, availability, provider, auction, location and shipping. Returns listing summaries in the requested language and currency, with the total when known; pass the returned searchAfter object unchanged to get the next page. For a signed-in user, each result also carries userState sections for which the token has the read scope: watchlist:read, search-filters:read, notifications:read or users:read. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents.

Mark every notification of the signed-in user as seen or unseen, including those beyond the listed page. Returns an empty object.

Mark one of the signed-in user's notifications as seen or unseen by notificationId. Returns an empty object; an unknown ID returns NOT_FOUND.

Mark the signed-in user's notifications with the given notificationIds (at least one) as seen or unseen. Unknown IDs are ignored. Returns an empty object.

Record whether a listing that matched one of the signed-in user's saved searches is relevant: true or false sets the feedback, null clears it and omission keeps it. Returns the match; a listing that is not a current match returns NOT_FOUND. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents.

Update the signed-in user's name, language, currency, measurement unit or whether unassessed or sensitive content is shown. Omitted fields stay unchanged and null clears an optional field; the content preference cannot be null. Returns the updated account.

Replace the label and location of one of the signed-in user's saved addresses. expectedVersion must equal the address's current version; a stale version returns CONFLICT. Returns the updated address.

Change the name, criteria, state or notification setting of one of the signed-in user's saved searches. Omitted fields stay unchanged and null clears fields that can be cleared; availability, orderability and includeUnspecifiedAvailability change together. Matching against new criteria runs in the background. Returns the saved search. Amounts are always integers in the currency's minor unit when one exists (EUR `119199` = €1,191.99; USD in cents). For currencies without minor units, such as JPY, the amount is whole units (`211453` = ¥211,453). Follow ISO 4217 exponents.