Introduction
This documentation provides a reference of the endpoints available in the
CDATA Service API. Placeholder variables in the examples are wrapped in braces,
such as {API_KEY}.
Authentication
Your API key must be provided in the
api_keyquery string variable:
curl "http://api.cdata.christies.tech/services/objects/?api_key={API_KEY}"
Make sure to replace
{API_KEY}with your API key.
All API (except of requests for manage data) endpoints will authenticate requests using the provided API key.
Authentication for manage
Get api key by email (only for trusted servers)
# curl request
$ curl https://api.cdata.christies.tech/primus/login/key -H "Content-Type: application/json" -H "x-api-key: {your api key}" -d '{"email":"correct@email.com"}'
{"user":{"id":1,"email":"correct@email.com"},"exp":1540552855,"api_key":"eyJhbGciOiJIU...aaMCvpDy3Xjw"}
Get api key by email/password
# curl request with bad email / password
$ curl https://api.cdata.christies.tech/primus/login -H "Content-Type: application/json" -d '{"email":"bad@email.com","password":"xyz"}'
{"message":"Could not login"}
# curl request with correct email / password
$ curl https://api.cdata.christies.tech/primus/login -H "Content-Type: application/json" -d '{"email":"correct@email.com","password":"xyz"}'
{"user":{"id":1,"email":"correct@email.com"},"exp":1540552855,"api_key":"eyJhbGciOiJIU...aaMCvpDy3Xjw"}
# Response example
{
"user": {
"id": 1,
"email": "correct@email.com"
},
"exp": 1540552855,
"api_key": "eyJhbGciOiJIUzUx...GnVgb-mjo9maaMCvpDy3Xjw"
}
This endpoint retrieves an api key for using it in create/update/delete requests (POST/PUT/DELETE).
Such requests (POST/PUT/DELETE) will require a header named authorization with content Bearer {API_KEY}.
API keys expire 30 days after creation. Once expired, the API will respond with a 401 status code.
The frequency of requesting API keys is not limited.
HTTP Request
POST https://api.cdata.christies.tech/primus/login
# POST parameters
{
"email": "correct@email.com",
"password": "xyz"
}
POST Parameters
| Parameter | Description |
|---|---|
| String. Your email | |
| password | String. Your password |
Response fields
| Field | Description |
|---|---|
| user | Authorized user data |
| exp | Timestamp of expire api key |
| api_key | Api key for using it in requests for manage data |
Revoke api key
The simple way: just stop to use and forget api key on side of your app, and get a new api key
# curl request for revoke api key
curl https://api.cdata.christies.tech/primus/logout -X "DELETE" -H "authorization: Bearer {your api key}"
HTTP Request
DELETE https://api.cdata.christies.tech/primus/logout
# headers for HTTP request
{
"authorization": "Bearer {your api key}"
}
Auction House
The following endpoints are available for querying Auction Houses.
List Auction Houses
curl "https://api.cdata.christies.tech/primus/auction_houses?api_key={API_KEY}"
{
"auction_houses": [
{"uuid": "...", ...},
...
]
}
This endpoint retrieves a list of auction houses.
HTTP Request
GET https://api.cdata.christies.tech/primus/auction_houses?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| query | String. Filter auction houses title |
| uuids | List. Filter by uuids |
Find an Auction House by UUID
curl "https://api.cdata.christies.tech/primus/auction_houses/{UUID}?api_key={API_KEY}"
{
"auction_houses": {
"uuid": "f7f4434e-cf9f-4b57-8d12-74d3e59f8e37",
"title": "Auctions By The Bay Inc"
}
}
This endpoint retrieves a single auction house by UUID.
HTTP Request
GET https://api.cdata.christies.tech/primus/auction_houses/{UUID}?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| UUID | String. The auction house UUID |
Audit Log
The following endpoints are available for querying Audit Logs
List Audit Logs
curl "https://api.cdata.christies.tech/primus/audit_logs?api_key={API_KEY}"
{
"audit_logs": [
{
"uuid": "d85ab420-f0c7-4762-b9a2-181892d43739",
"target_uuid": "d1564182-a95e-4a20-9f9e-26de7bd92a64",
"operation": "merge",
"model": "organization",
"inserted_at": "2018-03-29T15:14:14.511569"
},
...
]
}
This endpoint retrieves a list of audit logs.
HTTP Request
GET https://api.cdata.christies.tech/primus/audit_logs?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| model | String. Filter audit logs with model |
| operation | String. Filter audit logs with operation |
| target_uuid | String. Filter audit logs with target_uuid |
| uuid | String. Filter audit logs with uuid |
Location
The following endpoints are available for querying Locations.
List locations
curl "https://api.cdata.christies.tech/primus/locations?api_key={API_KEY}"
{
"locations": [
{"uuid": "...", ...},
...
]
}
This endpoint retrieves list of locations matching the query parameters.
HTTP Request
GET https://api.cdata.christies.tech/primus/locations?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| auction_house_uuids | List. Filter locations with auction_house_uuid in the list |
| query | String. Filter locations with title |
| uuids | List. Filter by uuids |
Find a Location by UUID
curl "https://api.cdata.christies.tech/primus/locations/{UUID}?api_key={API_KEY}"
{
"location": {
"uuid": "337415f7-bb13-4db3-b226-01961c0a5c78",
"title": "Alpaca Corp - Aventura",
"organization_uuid": "26bfeff1-4f29-400a-813a-ff2398c8d969",
"organization_title": "Alpaca Corp",
"country": "US",
"continent": null,
"city": "Aventura",
"address": "19275 Biscayne BlvdSuite # 41"
}
}
This endpoint retrieves a single location by UUID.
HTTP Request
GET https://api.cdata.christies.tech/primus/locations/{UUID}?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| UUID | String. The location UUID |
Lot
Each sale has multiple lots and objects. The following endpoints are available for querying Lots.
Export
curl "https://api.cdata.christies.tech/primus/lots/export?api_key={API_KEY}"
curl "https://api.cdata.christies.tech/primus/lots/export?scroll_id=XXX&api_key={API_KEY}"
{
"next_scroll_id": "XXXXXXXXXXXXXXXXXXXXXXXX",
"lots": [...]
}
This endpoint exports all legal lots using the Elasticsearch Scroll API.
The first request should be /lots/export without any param, the response will include next_scroll_id
which should then be used on the next request to retrieve the next results: /lots/export?scroll_id=RETURNED_NEXT_SCROLL_ID.
The process should be repeated until the response does not include next_scroll_id which means all records have been returned.
HTTP Request
GET https://api.cdata.christies.tech/primus/lots/export/?api_key={API_KEY}
GET https://api.cdata.christies.tech/primus/lots/export/?scroll_id=XXXXX&api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| scroll_id | String. The returned id for the next scroll |
| scroll_size | String. Default to 1000. The size of each page for the scroll to be generated |
List lots
curl "https://api.cdata.christies.tech/primus/lots/?session_start_date_from=2018-01-01&api_key={API_KEY}"
{
"lots": [
{"uuid": "...", ...},
...
]
}
This endpoint retrieves list of lots matching the query parameters.
HTTP Request
GET https://api.cdata.christies.tech/primus/lots?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| uuids | List . Filter by uuids |
| auction_house_uuids | List. Filter lots with auction_house_uuid in the list |
| cdata_category_uuids | List. Filter lots with cdata_category_uuid in the list |
| estimate_type_uuid | Float. Filter lots with estimate type identifier |
| estimate_type_term | Float. Filter lots with estimate type term |
| estimate_cad_from | Float. Filter lots with estimates cad greater or equal |
| estimate_cad_to | Float. Filter lots with cad estimates less or equal |
| estimate_low_cad_from | Float. Filter lots with estimate_low_cad greater or equal |
| estimate_low_cad_to | Float. Filter lots with estimate_low_cad less or equal |
| estimate_high_cad_from | Float. Filter lots with estimate_high_cad greater or equal |
| estimate_high_cad_to | Float. Filter lots with estimate_high_cad less or equal |
| price_hammer_cad_from | Float. Filter lots with price_hammer_cad greater or equal |
| price_hammer_cad_to | Float. Filter lots with price_hammer_cad less or equal |
| price_premium_cad_from | Float. Filter lots with price_premium_cad greater or equal |
| price_premium_cad_to | Float. Filter lots with price_premium_cad less or equal |
| price_cad_from | Float. Filter lots with price_cad greater or equal |
| price_cad_to | Float. Filter lots with price_cad less or equal |
| estimate_chf_from | Float. Filter lots with estimates chf greater or equal |
| estimate_chf_to | Float. Filter lots with chf estimates less or equal |
| estimate_low_chf_from | Float. Filter lots with estimate_low_chf greater or equal |
| estimate_low_chf_to | Float. Filter lots with estimate_low_chf less or equal |
| estimate_high_chf_from | Float. Filter lots with estimate_high_chf greater or equal |
| estimate_high_chf_to | Float. Filter lots with estimate_high_chf less or equal |
| price_hammer_chf_from | Float. Filter lots with price_hammer_chf greater or equal |
| price_hammer_chf_to | Float. Filter lots with price_hammer_chf less or equal |
| price_premium_chf_from | Float. Filter lots with price_premium_chf greater or equal |
| price_premium_chf_to | Float. Filter lots with price_premium_chf less or equal |
| price_chf_from | Float. Filter lots with price_chf greater or equal |
| price_chf_to | Float. Filter lots with price_chf less or equal |
| estimate_eur_from | Float. Filter lots with estimates eur greater or equal |
| estimate_eur_to | Float. Filter lots with eur estimates less or equal |
| estimate_low_eur_from | Float. Filter lots with estimate_low_eur greater or equal |
| estimate_low_eur_to | Float. Filter lots with estimate_low_eur less or equal |
| estimate_high_eur_from | Float. Filter lots with estimate_high_eur greater or equal |
| estimate_high_eur_to | Float. Filter lots with estimate_high_eur less or equal |
| price_hammer_eur_from | Float. Filter lots with price_hammer_eur greater or equal |
| price_hammer_eur_to | Float. Filter lots with price_hammer_eur less or equal |
| price_premium_eur_from | Float. Filter lots with price_premium_eur greater or equal |
| price_premium_eur_to | Float. Filter lots with price_premium_eur less or equal |
| price_eur_from | Float. Filter lots with price_eur greater or equal |
| price_eur_to | Float. Filter lots with price_eur less or equal |
| estimate_gbp_from | Float. Filter lots with estimates gbp greater or equal |
| estimate_gbp_to | Float. Filter lots with gbp estimates less or equal |
| estimate_low_gbp_from | Float. Filter lots with estimate_low_gbp greater or equal |
| estimate_low_gbp_to | Float. Filter lots with estimate_low_gbp less or equal |
| estimate_high_gbp_from | Float. Filter lots with estimate_high_gbp greater or equal |
| estimate_high_gbp_to | Float. Filter lots with estimate_high_gbp less or equal |
| price_hammer_gbp_from | Float. Filter lots with price_hammer_gbp greater or equal |
| price_hammer_gbp_to | Float. Filter lots with price_hammer_gbp less or equal |
| price_premium_gbp_from | Float. Filter lots with price_premium_gbp greater or equal |
| price_premium_gbp_to | Float. Filter lots with price_premium_gbp less or equal |
| price_gbp_from | Float. Filter lots with price_gbp greater or equal |
| price_gbp_to | Float. Filter lots with price_gbp less or equal |
| estimate_hkd_from | Float. Filter lots with estimates hkd greater or equal |
| estimate_hkd_to | Float. Filter lots with hkd estimates less or equal |
| estimate_low_hkd_from | Float. Filter lots with estimate_low_hkd greater or equal |
| estimate_low_hkd_to | Float. Filter lots with estimate_low_hkd less or equal |
| estimate_high_hkd_from | Float. Filter lots with estimate_high_hkd greater or equal |
| estimate_high_hkd_to | Float. Filter lots with estimate_high_hkd less or equal |
| price_hammer_hkd_from | Float. Filter lots with price_hammer_hkd greater or equal |
| price_hammer_hkd_to | Float. Filter lots with price_hammer_hkd less or equal |
| price_premium_hkd_from | Float. Filter lots with price_premium_hkd greater or equal |
| price_premium_hkd_to | Float. Filter lots with price_premium_hkd less or equal |
| price_hkd_from | Float. Filter lots with price_hkd greater or equal |
| price_hkd_to | Float. Filter lots with price_hkd less or equal |
| estimate_usd_from | Float. Filter lots with estimates usd greater or equal |
| estimate_usd_to | Float. Filter lots with usd estimates less or equal |
| estimate_low_usd_from | Float. Filter lots with estimate_low_usd greater or equal |
| estimate_low_usd_to | Float. Filter lots with estimate_low_usd less or equal |
| estimate_high_usd_from | Float. Filter lots with estimate_high_usd greater or equal |
| estimate_high_usd_to | Float. Filter lots with estimate_high_usd less or equal |
| price_hammer_usd_from | Float. Filter lots with price_hammer_usd greater or equal |
| price_hammer_usd_to | Float. Filter lots with price_hammer_usd less or equal |
| price_premium_usd_from | Float. Filter lots with price_premium_usd greater or equal |
| price_premium_usd_to | Float. Filter lots with price_premium_usd less or equal |
| price_usd_from | Float. Filter lots with price_usd greater or equal |
| price_usd_to | Float. Filter lots with price_usd less or equal |
| has_price_hammer | Boolean. Filter lots with has/not of hammer price |
| has_price_premium | Boolean. Filter lots with has/not of premium price |
| price_type_term | String. Filter lots by price_type_term |
| price_type_uuid | String. Filter lots by price_type_uuid |
| exclude_auction_houses | Boolean/true. Should be used together with parameter auction_house_uuids. Filter lots without auction houses which are listed in auction_house_uuids parameter |
| maker_modifier_uuids | List. Filter lots with maker.modifier_uuid in the list. Should contain list with once null for filter a lots with maker.modifier_uuid=null |
| maker_qualifier_uuids | Alias for maker_modifier_uuids |
| maker_uuids | List. Filter lots with maker_uuid in the list |
| sale_uuids | List. Filter lots with sale_uuid in the list |
| session_start_date_from | Date. Filter lots with session_start_date greater or equal |
| session_start_date_to | Date. Filter lots with session_start_date less or equal |
| session_finish_date_from | Date. Filter lots with session_finish_date greater or equal |
| session_finish_date_to | Date. Filter lots with session_finish_date less or equal |
| session_uuids | List. Filter lots with session_uuid in the list |
| shown | Boolean. Filter lots with shown true or false |
| sort_by | String. Sort results by selected field |
| sort_order | String. Sort results with selected order |
| statuses | List. Filter lots with status in the list |
| numbers | List. Filter lots with numbers in the list |
| number | String. Filter lots with number in the list |
| creation_place_uuids | List. Filter lots with objects.creation_pace_uuid in the list |
| style_uuids | List. Filter lots with objects.style_uuid in the list |
| creation_year_from | Integer. Filter lots with objects.creation_start_year greater or equal |
| creation_year_to | Integer. Filter lots with objects.creation_start_year less or equal |
| sale_channel_uuids | List. Filter lots with channel uuid in the list |
| sale_channel_terms | List. Filter lots with channel term in the list |
| sale_location_uuids | List. Filter lots with location in the list |
| sale_country_uuids | List. Filter lots with country identifier in the list |
| sale_country_name | String. Filter lots with sale country name in the list |
| sale_city_name | String. Filter lots with sale city name in the list |
| sale_region_name | String. Filter lots with sale region name in the list |
| sale_room_codes | String. Filter lots with sale christies room code in te list |
| region_uuids | List. Filter lots with country group (region) |
| estimate_usd_from | Integer. Filter lots with estimate greater or equal. USD currency |
| estimate_usd_to | Integer. Filter lots with estimate less or equal. USD currency |
| last_modified_at_from | Date. Filter lots with last_modified_at greater or equal |
| last_modified_at_to | Date. Filter lots with last_modified_at less or equal |
| clusters | List. Filter lots with clusters in the list |
| departments | List. Filter lots with departments in the list |
Sorting fields
| Field | |
|---|---|
| inserted_at | Default, desc |
| title | |
| number | |
| sale_number | |
| creation_start_year | |
| price_sale_usd | |
| estimate_low_usd | |
| status | |
| auction_house_name | |
| session_start_date | |
| session_finish_date | |
| categories | Sort by pair of cdata categories |
| price_hammer_usd | Hammer Price USD |
| price_hammer_chf | Hammer Price CHF |
| price_hammer_eur | Hammer Price EUR |
| price_hammer_gbp | Hammer Price GBP |
| price_hammer_hkd | Hammer Price HKD |
| price_hammer_cad | Hammer Price CAD |
Find a lot by UUID
curl "https://api.cdata.christies.tech/primus/lots/{UUID}?api_key={API_KEY}"
{
"lot": {
"uuid": "38feb82e-c134-4fff-92d6-c7b892f46120",
"title": "A pair of George IV silver-topped cut glass oblong toilet boxes, the ribbed hinged covers gilt-lined, London 1829 - 3½in. (2)X33467",
"status": "Sold",
"source_id": null,
"source": "christies",
"shown": true,
"session_uuid": "52e94d9b-baea-4949-9562-6884e5d2e043",
"session_start_date": "1992-05-19",
"session_finish_date": "1992-05-19",
"sale_uuid": "51f5b278-dcd7-455f-8bcb-608b89699b19",
"sale_title": "Silver and Wine Related Items",
"price": 132,
"price_cad": 242.64,
"price_chf": 242.64,
"price_eur": 242.64,
"price_gbp": 242.64,
"price_hkd": 242.64,
"price_usd": 242.64,
"estimate_low": 132,
"estimate_low_cad": 242.64,
"estimate_low_chf": 242.64,
"estimate_low_eur": 242.64,
"estimate_low_gbp": 242.64,
"estimate_low_hkd": 242.64,
"estimate_low_usd": 242.64,
"estimate_high": 132,
"estimate_high_cad": 242.64,
"estimate_high_chf": 242.64,
"estimate_high_eur": 242.64,
"estimate_high_gbp": 242.64,
"estimate_high_hkd": 242.64,
"estimate_high_usd": 242.64,
"price_sale": 132,
"price_sale_cad": 242.64,
"price_sale_chf": 242.64,
"price_sale_eur": 242.64,
"price_sale_gbp": 242.64,
"price_sale_hkd": 242.64,
"price_sale_usd": 242.64,
"price_premium": 132,
"price_premium_cad": 242.64,
"price_premium_chf": 242.64,
"price_premium_eur": 242.64,
"price_premium_gbp": 242.64,
"price_premium_hkd": 242.64,
"price_premium_usd": 242.64,
"price_hammer": 132,
"price_hammer_cad": 242.64,
"price_hammer_chf": 242.64,
"price_hammer_eur": 242.64,
"price_hammer_gbp": 242.64,
"price_hammer_hkd": 242.64,
"price_hammer_usd": 242.64,
"bought_in_at": 132,
"bought_in_at_cad": 242.64,
"bought_in_at_chf": 242.64,
"bought_in_at_eur": 242.64,
"bought_in_at_gbp": 242.64,
"bought_in_at_hkd": 242.64,
"bought_in_at_usd": 242.64,
"jewelry_price_per_carat_usd": 10000,
"object_uuids": ["7e3ca41d-3f97-4cc1-9c75-09d7b7757dcd"],
"objects": [
{
"uuid": "7e3ca41d-3f97-4cc1-9c75-09d7b7757dcd",
"title": "A pair of George IV silver-topped cut glass oblong toilet boxes, the ribbed hinged covers gilt-lined, London 1829 - 3½in. (2)X33467",
...
}
],
"number": "0257",
"is_premium_price": true,
"id": 10512486,
"description": null,
"auction_house_name": "Christie's",
"auction_house_uuid": "5dcadd63-cc05-4532-9071-53cfa3fcd565",
"clusters": ["Post-War & Contemporary"],
"departments": ["Photographs"],
"inserted_at": "2019-02-07T07:19:00.845061Z",
"last_modified_at": "2019-02-07T07:19:00.845061Z"
}
}
This endpoint retrieves a single lot by UUID.
HTTP Request
GET https://api.cdata.christies.tech/primus/lots/{UUID}?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| UUID | String. The lot UUID |
Lot fields description
| Path of lot field | Description | Read only |
|---|---|---|
| uuid | String. Lot identifier | + |
| shown | Boolean. Flag of lot accessible | + |
| title | String. Lot title (here is title from lot's object, when lot have not own title) | + |
| description | String. Lot description (here is description from lot's object, when lot have not own description) | + |
| number | String. Lot number | + |
| objects | List. Related objects | + |
| object_uuids | List. Related objects identifiers | + |
| estimate_low | Float. Value of low estimate in sale currency | + |
| estimate_low_usd | Float. Value of low estimate in USD currency | + |
| estimate_high | Float. Value of high estimate in sale currency | + |
| estimate_high_usd | Float. Value of high estimate in USD currency | + |
| price | Float. Value of published lot price in sale currency | + |
| price_usd | Float. Value of published lot price in USD currency | + |
| price_hammer | Float. Value of hammer lot price in sale currency | + |
| price_hammer_usd | Float. Value of hammer lot price in USD currency | + |
| price_premium | Float. Value of premium lot price in sale currency | + |
| price_premium_usd | Float. Value of premium lot price in USD currency | + |
| price_type_term | String. Value of price type of lot's sale | + |
| price_type_uuid | String. Uuid of price type of lot's sale | + |
| jewelry_price_per_carat_usd | Automatically calculated price per carat | + |
| estimate_type_uuid | String. Estimate type identifier | + |
| estimate_type_term | String. Estimate type term | + |
| bought_in_at | Float. Value of bought in at price in sale currency |
+ |
| bought_in_at_usd | Float. Value of bought in at price in USD currency |
+ |
| implied_bids_reserve | Integer. Implied bids reserve calculated value | + |
| implied_bids_low_estimate | Integer. Implied bids low estimate calculated value | + |
| is_premium_price | Boolean. Does no matter, always true | + |
| status | String. Lot status term | + |
| status_uuid | String. Lot status identifier | + |
| sale_uuid | String. Sale identifier | + |
| sale_title | String. Sale title | + |
| sale_number | String. Sale number | + |
| sale_location_uuid | String. Location identifier | + |
| sale_location_title | String. Location title | + |
| sale_country_uuid | String. Country identifier | + |
| sale_country_term | String. Country term (code) | + |
| sale_country_name | String. Full country name | + |
| sale_region_name | String. Sale location region name | + |
| sale_region_uuid | String. Sale region uuid | + |
| sale_city_name | String. Sale location city name | + |
| sale_room_code | String. Sale Christies location room code | + |
| sale_channel_uuid | String. Channel identifier | + |
| sale_channel_term | String. Channel term | + |
| session_uuid | String. Session identifier | + |
| auction_house_uuid | String. Auction house identifier | + |
| auction_house_name | String. Auction house name | + |
| clusters | List. Cluster names | + |
| departments | List. Department names | + |
| source | String. Name of lot's data source (i.e christies) |
+ |
| source_id | Integer. Lot's data source identifier (i.e christies object id) |
+ |
| session_start_date | Date. Start lot's session date | + |
| session_finish_date | Date. Finish lot's session date | + |
| inserted_at | Datetime of creating record | + |
| last_modified_at | The GREATEST value between lot, object and entity_lot updated_at | + |
Lots stats
curl "https://api.cdata.christies.tech/primus/lots/stats?api_key={API_KEY}&auction_house_uuids[]={UUID}&maker_uuids[]={UUID}&maker_qualifier_uuids[]=null"
{
"stats": {
"totals": {
"overall": {
"estimate_low_cad": 456,
"estimate_low_chf": 456,
"estimate_low_eur": 456,
"estimate_low_gbp": 456,
"estimate_low_hkd": 456,
"estimate_low_usd": 456,
"estimate_high_cad": 567,
"estimate_high_chf": 567,
"estimate_high_eur": 567,
"estimate_high_gbp": 567,
"estimate_high_hkd": 567,
"estimate_high_usd": 567,
"price_premium_cad": 123,
"price_premium_chf": 123,
"price_premium_eur": 123,
"price_premium_gbp": 123,
"price_premium_hkd": 123,
"price_premium_usd": 123,
"price_hammer_cad": 345,
"price_hammer_chf": 345,
"price_hammer_eur": 345,
"price_hammer_gbp": 345,
"price_hammer_hkd": 345,
"price_hammer_usd": 345,
"price_sale_cad": 345,
"price_sale_chf": 345,
"price_sale_eur": 345,
"price_sale_gbp": 345,
"price_sale_hkd": 345,
"price_sale_usd": 345,
},
"ROM": {
"estimate_low_cad": 456,
"estimate_low_chf": 456,
"estimate_low_eur": 456,
"estimate_low_gbp": 456,
"estimate_low_hkd": 456,
"estimate_low_usd": 456,
"estimate_high_cad": 567,
"estimate_high_chf": 567,
"estimate_high_eur": 567,
"estimate_high_gbp": 567,
"estimate_high_hkd": 567,
"estimate_high_usd": 567,
"price_premium_cad": 123,
"price_premium_chf": 123,
"price_premium_eur": 123,
"price_premium_gbp": 123,
"price_premium_hkd": 123,
"price_premium_usd": 123,
"price_hammer_cad": 345,
"price_hammer_chf": 345,
"price_hammer_eur": 345,
"price_hammer_gbp": 345,
"price_hammer_hkd": 345,
"price_hammer_usd": 345,
"price_sale_cad": 345,
"price_sale_chf": 345,
"price_sale_eur": 345,
"price_sale_gbp": 345,
"price_sale_hkd": 345,
"price_sale_usd": 345,
},
"Christie's": {
"estimate_low_cad": 456,
"estimate_low_chf": 456,
"estimate_low_eur": 456,
"estimate_low_gbp": 456,
"estimate_low_hkd": 456,
"estimate_low_usd": 456,
"estimate_high_cad": 567,
"estimate_high_chf": 567,
"estimate_high_eur": 567,
"estimate_high_gbp": 567,
"estimate_high_hkd": 567,
"estimate_high_usd": 567,
"price_premium_cad": 123,
"price_premium_chf": 123,
"price_premium_eur": 123,
"price_premium_gbp": 123,
"price_premium_hkd": 123,
"price_premium_usd": 123,
"price_hammer_cad": 345,
"price_hammer_chf": 345,
"price_hammer_eur": 345,
"price_hammer_gbp": 345,
"price_hammer_hkd": 345,
"price_hammer_usd": 345,
"price_sale_cad": 345,
"price_sale_chf": 345,
"price_sale_eur": 345,
"price_sale_gbp": 345,
"price_sale_hkd": 345,
"price_sale_usd": 345,
},
"Bonhams": {
"estimate_low_cad": 456,
"estimate_low_chf": 456,
"estimate_low_eur": 456,
"estimate_low_gbp": 456,
"estimate_low_hkd": 456,
"estimate_low_usd": 456,
"estimate_high_cad": 567,
"estimate_high_chf": 567,
"estimate_high_eur": 567,
"estimate_high_gbp": 567,
"estimate_high_hkd": 567,
"estimate_high_usd": 567,
"price_premium_cad": 123,
"price_premium_chf": 123,
"price_premium_eur": 123,
"price_premium_gbp": 123,
"price_premium_hkd": 123,
"price_premium_usd": 123,
"price_hammer_cad": 345,
"price_hammer_chf": 345,
"price_hammer_eur": 345,
"price_hammer_gbp": 345,
"price_hammer_hkd": 345,
"price_hammer_usd": 345,
"price_sale_cad": 345,
"price_sale_chf": 345,
"price_sale_eur": 345,
"price_sale_gbp": 345,
"price_sale_hkd": 345,
"price_sale_usd": 345,
}
},
"performance": {
"overall": {
"within_estimates": 123,
"below_estimate_low": 234,
"above_estimate_high": 345
},
"ROM": {
"within_estimates": 123,
"below_estimate_low": 234,
"above_estimate_high": 345
},
"Christie's": {
"within_estimates": 123,
"below_estimate_low": 234,
"above_estimate_high": 345
},
"Bonhams": {
"within_estimates": 123,
"below_estimate_low": 234,
"above_estimate_high": 345
}
},
"implied_bids": {
"reserve": {
"overall": {
"0": 123,
"1": 234,
"5-9": 345,
"2-4": 456,
"10+": 567
},
"ROM": {
"0": 123,
"1": 234,
"5-9": 345,
"2-4": 456,
"10+": 567
},
"Christie's": {
"0": 123,
"1": 234,
"5-9": 345,
"2-4": 456,
"10+": 567
},
"Bonhams": {
"0": 123,
"1": 234,
"5-9": 345,
"2-4": 456,
"10+": 567
}
},
"low_estimate": {
"overall": {
"0": 123,
"1": 234,
"5-9": 345,
"2-4": 456,
"10+": 567
},
"ROM": {
"0": 123,
"1": 234,
"5-9": 345,
"2-4": 456,
"10+": 567
},
"Christie's": {
"0": 123,
"1": 234,
"5-9": 345,
"2-4": 456,
"10+": 567
},
"Bonhams": {
"0": 123,
"1": 234,
"5-9": 345,
"2-4": 456,
"10+": 567
}
},
"average": {
"overall": 1.48,
"ROM": 1.75,
"Christie's": 2.28,
"Bonhams": 3.82
}
},
"counts": {
"overall": {
"sold": 123,
"offered": 234
},
"ROM": {
"sold": 123,
"offered": 234
},
"Christie's": {
"sold": 123,
"offered": 234
},
"Bonhams": {
"sold": 123,
"offered": 234
}
}
}
}
This endpoint retrieves lots stats.
HTTP Request
GET https://api.cdata.christies.tech/primus/lots/stats?api_key={API_KEY}
URL Parameters
Parameters is equal to List lots section
Lots stats v2
curl "https://api.cdata.christies.tech/primus/lots/stats/v2?api_key={API_KEY}&auction_house_uuids[]={UUID}&maker_uuids[]={UUID}&maker_qualifier_uuids[]=null"
# changes in version 2
{
"stats": {
...
"implied_bids": {
...
reserve: {
"Christie's": {"0": 1, "1": 1, "2": 1, "5": 1},
"ROM": {"0": 2, "1": 1},
"Sotheby's": {"0": 1, "4": 1},
"overall": {"0": 4, "1": 2, "2": 1, "4": 1, "5": 1}
},
low_estimate: {
"Christie's": {"0": 1, "1": 1, "2": 1, "5": 1},
"ROM": {"0": 2, "1": 1},
"Sotheby's": {"0": 1, "4": 1},
"overall": {"0": 4, "1": 2, "2": 1, "4": 1, "5": 1}
}
...
}
}
}
This endpoint retrieves lots stats, version 2.
HTTP Request
GET https://api.cdata.christies.tech/primus/lots/stats/v2?api_key={API_KEY}
URL Parameters
Parameters is equal to List lots section
Similar
curl "https://api.cdata.christies.tech/primus/lots/similar?christies_object_id={christies_object_id}&api_key={API_KEY}"
{
"lots": [
{"uuid": "...", ...},
...
]
}
Retrieve a list of lots similar to an existing lot one, specified by the christies object id or CDATA UUID.
*_weight parameters can be used to configure the relative importance of each parameter in defining artwork similarity
To get only upcoming lots sale_date_from can be set to the current date (YYYY-MM-DD).
HTTP Request
GET https://api.cdata.christies.tech/primus/lots/similar?christies_object_id={christies_object_id}&sale_date_from={YYYY-MM-DD}&api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| christies_object_id | String. Filter lots with christies_object_id |
| object_uuid | String. Filter lots with object_uuid |
| maker_weight | Float. Default 5. Importance of maker in the results calculation |
| image_weight | Float. Default 5. Importance of image in the results calculation |
| title_weight | Float. Default 1. Importance of title in the results calculation |
| sale_title_weight | Float. Default 1. Importance of sale_title in the results calculation |
| sale_date_from | Date. Filter lots with sale_date greater or equal |
| sale_date_to | Date. Filter lots with sale_date less or equal |
| measurement_weight | Float. Default 1. Importance of measurement in the results calculation |
| creation_year_weight | Float. Default 1. Importance of creation_year in the results calculation |
| medium_weight | Float. Default 1. Importance of medium in the results calculation |
| price_weight | Float. Default 1. Importance of price in the results calculation |
| category_weight | Float. Default 1. Importance of category in the results calculation |
| min_score | Float. Default 20. Minimum score to return |
| page_size | Integer. Number of records per page |
Maker
The following endpoints are available for querying Makers.
List Makers
curl "https://api.cdata.christies.tech/primus/makers?api_key={API_KEY}"
{
"makers": [
{"uuid": "...", ...},
...
]
}
This endpoint retrieves list of makers matching the query parameters.
HTTP Request
GET https://api.cdata.christies.tech/primus/makers?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| nationality_uuids | List. Filter makers with nationality_uuid in the list |
| query | String. Filter makers names weighted by objects_count |
| role_uuids | List. Filter makers with role_uuid in the list |
| type | String. Filter makers with type |
| uuids | List. Filter by uuids |
Sorting fields
| Field | |
|---|---|
| name | Default, asc |
| type | |
| existence_start_year | |
| objects_count |
Match Makers
curl "https://api.cdata.christies.tech/primus/makers/match?api_key={API_KEY}&name=Andy Warhol"
# Response example
{
"makers": [
{
"uuid": "a0316264-70a4-4c3e-a139-ad6cc7625432",
"name": "Andy Warhol",
"type": "person", # or "organization"
}
]
}
This endpoint retrieves list of makers matching the query parameters.
HTTP Request
GET https://api.cdata.christies.tech/primus/makers/match?api_key={API_KEY}&name=Andy Warhol
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| * name | String. Artist name (e.g. "Andy Warhol") or Organization title (e.g. "Rolex") |
| birth_year | Deprecated. Integer. Artist birth year (e.g. 1928) |
| death_year | Deprecated. Integer. Artist death year (e.g. 1987) |
| maker_start_year | Integer. Artist birth year (e.g. 1928) or starting year of Organization's existence |
| maker_finish_year | Integer. Artist death year (e.g. 1987) or finishing year of Organization's existence |
| date_text | String. Alternative text-based input to start/finish_year (e.g. "18th century") |
| nationality_uuid | String. Artist/Organization nationality UUID |
| start_year | Integer. Artwork creation date range start (e.g. 1975) |
| finish_year | Integer. Artwork creation date range end (e.g. 1979) |
| cdata_category_uuid | String. Category UUID |
| material_term_uuids | List. Material UUIDs |
| measurements | List. Normalized measurement values (e.g. [75, 90]) |
Find a Maker by UUID
curl "https://api.cdata.christies.tech/primus/makers/{UUID}?api_key={API_KEY}"
{
"maker": {
"uuid": "c61e15de-5879-42b5-bba2-34cf72c3278a",
"type": "organization",
"role": "vehicle manufacturer",
"nationality": "American",
"names": [
"Chevrolet"
],
"name": "Chevrolet",
"existence_start_year": 1911,
"existence_finish_year": null,
"description": null,
"dates": "founded in 1911",
"inserted_at": "2019-02-07T07:19:00.845061Z"
}
}
This endpoint retrieves a single maker by UUID.
HTTP Request
GET https://api.cdata.christies.tech/primus/makers/{UUID}?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| UUID | String. The maker UUID |
Makers fields description
| Path of maker field | Description | Read only |
|---|---|---|
| uuid | String. Maker identifier | + |
| name | String. Maker preferred name | + |
| names | List. Maker's all names | + |
| description | String. Maker's additional info | + |
| dates | String. Existence years (free text) | + |
| existence_start_year | Integer. Existence start year | + |
| existence_finish_year | Integer. Existence finish year | + |
| nationality | String. Nationality term | + |
| nationality_uuid | String. Nationality uuid | + |
| role | String. Preferred role term | + |
| role_uuids | List. Roles identifiers | + |
| type | String. Maker's type (person/organization) | + |
| objects_count | Integer. Count of maker's objects | + |
| inserted_at | Datetime. Time of creating | + |
Object
Each lot of a sale has one or more related objects, which represent the actual item on sale. The following endpoints are available for querying objects.
List Objects
curl "https://api.cdata.christies.tech/primus/objects/?creation_year_from=1953&api_key={API_KEY}"
{
"objects": [
{"uuid": "...", ...},
...
]
}
This endpoint retrieves list of objects matching the query parameters.
HTTP Request
GET https://api.cdata.christies.tech/primus/objects?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | Your API key |
| uuids | List. Filter by uuids |
| auction_house_uuids | List. Filter objects with auction_house_uuid in the list |
| cdata_category_uuids | List. Filter objects with cdata_category_uuid in the list |
| creation_year_from | Integer. Find objects created from this year |
| creation_year_to | Integer. Find objects created to this year |
| maker_uuids | List. Filter objects with maker_uuid in the list |
| sale_uuids | List. Filter objects with sale_uuid in the list |
| session_start_date_from | Date. Find objects with sessions from this date |
| session_start_date_to | Date. Find objects with sessions to this date |
| session_uuids | List. Filter objects with session_uuid in the list |
| query | String. Filter objects with title |
| fuzzy_query | String. Filter objects with title using fuzziness |
| measurement_weight_min | Float/Integer. Filter objects with min value of measurement: weight (g) |
| measurement_weight_max | Float/Integer. Filter objects with max value of measurement: weight (g) |
| measurement_width_min | Float/Integer. Filter objects with min value of measurement: width (cm) |
| measurement_width_max | Float/Integer. Filter objects with max value of measurement: width (cm) |
| measurement_height_min | Float/Integer. Filter objects with min value of measurement: height (cm) |
| measurement_height_max | Float/Integer. Filter objects with max value of measurement: height (cm) |
| measurement_depth_min | Float/Integer. Filter objects with min value of measurement: depth (cm) |
| measurement_depth_max | Float/Integer. Filter objects with max value of measurement: depth (cm) |
| color_uuids | List. Filter objects with color in the list |
| material_uuids | List. Filter objects with material in the list |
| shape_uuids | List. Filter objects with shape in the list |
| style_uuids | List. Filter objects with style in the list |
| creation_place_uuids | List. Filter objects with creation place in the list |
| edition_state_uuids | List. Filter objects with edition states in the list |
| has_images | Boolean/true. Filter objects with images |
| has_no_images | Boolean/true. Filter objects without images |
| has_makers | Boolean/true. Filter objects with makers |
| has_no_makers | Boolean/true. Filter objects without makers |
| jewelry_type_uuids | List. Filter objects with jewelry type in the list |
| jewelry_gem_setting_uuids | List. Filter objects with jewelry gem setting in the list |
| gem_clarity_uuids | List. Filter gem objects with clarity type in the list |
| gem_color_intensity_uuids | List. Filter gem objects with intensity type in the list |
| gem_colourless | Boolean. Filter gem objects by colourless flag |
| gem_cut_uuids | List. Filter gem objects with cut type in the list |
| gem_cut_grade_uuids | List. Filter gem objects with cut grade type in the list |
| gem_treatment_degree_uuids | List. Filter gem objects with treatment degree in the list |
| gem_treatment_type_uuids | List. Filter gem objects with treatment type in the list |
Sorting fields
| Field | |
|---|---|
| inserted_at | Default, desc |
| title | |
| maker | |
| creation_start_year | |
| categories | Sort by pair of cdata categories |
Match Objects
curl -F "image=@/path/to/image.jpg" -H "authorization: Bearer {API_KEY}" https://api.cdata.christies.tech/primus/objects/match
{
"object": {
"cdata_category_text": "Fine Art",
"cdata_category_uuid": "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab",
"cdata_subcategory_text": "Prints",
"cdata_subcategory_uuid": "451e50a5-5f4a-490b-a4a5-ca1b372a4296",
"creation_date_text": "1967",
"creation_finish_year": 1967,
"creation_start_year": 1967,
"description": "ANDY WARHOL, 11.27: Marilyn Monroe, Con sello en la parte posterior "Fill in your own signature", Serigrafía, 91 x 91 cm",
"edition": null,
"exhibition_history": null,
"images": [{
"large_url": "https://s3.amazonaws.com/cdata-images-v2-production/images/1206484/large.jpg",
"medium_url": "https://s3.amazonaws.com/cdata-images-v2-production/images/1206484/medium.jpg",
"thumb_url": "https://s3.amazonaws.com/cdata-images-v2-production/images/1206484/thumbnail.jpg",
"zoom_url": "https://s3.amazonaws.com/cdata-images-v2-production/images/1206484/zoom.jpg"
}],
"inscription": "Con sello en la parte posterior "Fill in your own signature"",
"lots": [{
"uuid": "8304ef1c-b97e-4a53-a09a-67864f560087",
"title": "Marilyn Monroe",
...
},
{
"uuid": "417dd5f2-dbe1-42c7-9c3a-1ce46233ae18"
"title": "Marilyn Monroe",
...
}
],
"makers": [{
"dates": "1928 - 1987",
"modifier_uuid": null,
"name": "Andy Warhol",
"uuid": "a0316264-70a4-4c3e-a139-ad6cc7625432"
}],
"materials": [{
"term": "silkscreen printing",
"vocabulary_item_uuid": "a1655d65-1d8e-47ca-96bc-ec23690fc232"
}],
"materials_text": "Serigraph",
"measurements": [{
"type": "height",
"type_uuid": "12e066b9-17dc-41d1-a1d9-7156ae7a7f66",
"unit": "cm",
"unit_uuid": "c3b17c20-5eb1-4d9d-8267-fb66e7f470d3",
"value": 91.0,
"value_normalized": 91.0
},
{
"type": "width",
"type_uuid": "91199fbe-eb10-47ef-a6e1-da376923d1d0",
"unit": "cm",
"unit_uuid": "c3b17c20-5eb1-4d9d-8267-fb66e7f470d3",
"value": 91.0,
"value_normalized": 91.0
}
],
"measurements_text": "91 x 91 cm",
"provenance": null,
"title": "Marilyn Monroe",
"uuid": "d1168091-9229-44b8-9cda-ecbe64a19c6a"
},
"score": 54,
"upcoming_lots": []
}
This endpoint retrieves list of objects matching the image and query parameters.
HTTP Request
POST https://api.cdata.christies.tech/primus/objects/match
Headers
| Parameter | Description |
|---|---|
| authorization | String. Format should be Bearer {API_KEY} |
Body Parameters
| Parameter | Description |
|---|---|
| image | Image. Image to match |
| christies_only | Boolean. Only match objects sold by Christie's |
| includes_upcoming_lots | Boolean. Include upcoming lots in response |
Find an Object by UUID
curl "https://api.cdata.christies.tech/primus/objects/{UUID}?api_key={API_KEY}"
{
"object": {
"uuid": "8e1f7d6d-66bc-451d-a512-a6f546f48eb7",
"title": "ATTRIBUTED ALFRED CORNELIUS HOWLAND (1838-1909)",
"shown": true,
"provenance_text": "E. Coe Kerr Gallery, Inc., New York",
"measurements_text": "canvas13 x 17in.",
"measurements": [{
"value_normalized": 43.17,
"value": 17.0,
"unit_uuid": "d31994f3-e639-4b49-8a65-3a285065c068",
"unit": "in",
"type_uuid": "91199fbe-eb10-47ef-a6e1-da376923d1d0",
"type": "width"
}, {
"value_normalized": 33.02,
"value": 13.0,
"unit_uuid": "d31994f3-e639-4b49-8a65-3a285065c068",
"unit": "in",
"type_uuid": "12e066b9-17dc-41d1-a1d9-7156ae7a7f66",
"type": "height"
}],
"materials_text": "oil on canvas",
"material_uuids": ["12e066b9-17dc-41d1-a1d9-7156ae7a7f66", "12e066b9-17dc-41d1-a1d9-7156ae7a7f66"],
"materials": [
{
"uuid": "12e066b9-17dc-41d1-a1d9-7156ae7a7f66",
"term": "oil",
},{
"uuid": "12e066b9-17dc-41d1-a1d9-7156ae7a7f66",
"term": "canvas",
}
],
"shape_uuids": ["12e066b9-17dc-41d1-a1d9-7156ae7a7f66", "12e066b9-17dc-41d1-a1d9-7156ae7a7f66"],
"shapes": [
{
"uuid": "12e066b9-17dc-41d1-a1d9-7156ae7a7f66",
"term": "almond-shaped",
},{
"uuid": "12e066b9-17dc-41d1-a1d9-7156ae7a7f66",
"term": "concave",
}
],
"color_uuids": ["12e066b9-17dc-41d1-a1d9-7156ae7a7f66"],
"colors": [{
"uuid": "12e066b9-17dc-41d1-a1d9-7156ae7a7f66",
"term": "pink",
}],
"style_uuids": ["12e066b9-17dc-41d1-a1d9-7156ae7a7f66"],
"styles": [{
"uuid": "12e066b9-17dc-41d1-a1d9-7156ae7a7f66",
"term": "Modern",
}],
"makers": [{
"uuid": "a3bd7038-392c-422e-ad98-51fab81a9440",
"name": "Alfred Cornelius Howland",
"modifier_term": "School of",
"modifier_uuid": "a3bd7038-392c-422e-ad98-51fab81a9440",
"dates": "1838 - 1909"
}],
"certifications": [{
"uuid": "a3bd7038-392c-422e-ad98-51fab81a9440",
"text": "Certification 1234/3456-SS1, 04-05-2015",
"number": "1234/3456-SS1",
"issuer_uuid": "716d60d3-9219-416e-af8f-249eb834ae35",
"issuer_name": "Jewelry and Co",
"date": "2015-05-04"
}],
"lot_uuids": ["1d58da99-ed78-4297-83e7-b9d17686b873"],
"lots": [{
"uuid": "1d58da99-ed78-4297-83e7-b9d17686b873",
"title": "ATTRIBUTED ALFRED CORNELIUS HOWLAND (1838-1909)",
...
}],
"inscription_text": null,
"images": [{
"uuid": "5dcadd63-cc05-4532-9071-53cfa3fcd565",
"url": "https://s3.amazonaws.com/cdata-images-v2-production/images/507985/original.jpg",
"large_url": "https://s3.amazonaws.com/cdata-images-v2-production/images/507985/large.jpg",
"medium_url": "https://s3.amazonaws.com/cdata-images-v2-production/images/507985/medium.jpg",
"thumb_url": "https://s3.amazonaws.com/cdata-images-v2-production/images/507985/thumbnail.jpg",
"zoom_url": "https://s3.amazonaws.com/cdata-images-v2-production/images/507985/zoom.jpg",
}],
"exhibition_history_text": "Gent, Galleria San Carlo, Lineart, 2012.",
"edition_text": null,
"edition_number": null,
"edition_state_term": null,
"edition_state_uuid": null,
"edition_size": null,
"creation_place_term": null,
"creation_place_uuid": null,
"creation_place_text": "Paris",
"description_text": "ATTRIBUTED ALFRED CORNELIUS HOWLAND (1838-1909)Street in a Rural Townoil on canvas13 x 17in. (33 x 43.2cm.)",
"literature_text": "Jean-Roger Soubiran, Gustav-Adolf Mossa, Nice, 2010, illustrated in full page, p. 233, n°320",
"creation_start_year": null,
"creation_finish_year": null,
"creation_date_text": null,
"cdata_subcategory_uuid": "a8157712-9b54-4c37-bb86-f00f79864188",
"cdata_subcategory_term": "Paintings",
"cdata_category_uuid": "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab",
"cdata_category_term": "Fine Art",
"mark_count": 0,
"mark_uuids": [],
"gem_count": 0,
"gem_uuids": [],
"gem_objects": [],
"jewelry_type_term": "Diamond ring",
"jewelry_type_uuid": "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab",
"jewelry_gem_setting_uuid": "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab",
"jewelry_gem_setting_term": "Bezel",
"gem_clarity_uuid": "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab",
"gem_clarity_term": "VVS",
"gem_treatment_type_term": "B",
"gem_treatment_type_uuid": "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab",
"gem_treatment_degree_term": null,
"gem_treatment_degree_uuid": null,
"gem_cut_term": "Round",
"gem_cut_uuid": "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab",
"gem_cut_grade_term": "Good",
"gem_cut_grade_uuid": "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab",
"gem_colourless": false,
"gem_color_intensity_term": "Fancy",
"gem_color_intensity_uuid": "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab",
"inserted_at": "2019-02-07T07:19:00.845061Z"
}
}
This endpoint retrieves a single object by UUID.
HTTP Request
GET https://api.cdata.christies.tech/primus/objects/{UUID}?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | Your API key |
| UUID | The object UUID |
Object fields description
All objects
| Path of object field | Description | Read only |
|---|---|---|
| uuid | Object identifier | + |
| title | Object title | |
| cdata_category_term | Label of category | + |
| cdata_category_uuid | Category identifier | |
| cdata_subcategory_term | Label of subcategory | + |
| cdata_subcategory_uuid | Subcategory identifier | |
| certifications | List of certifications | |
| certifications.date | Certification date | |
| certifications.issuer_uuid | Certificate issuer identifier | |
| certifications.issuer_name | Certificate issuer name/title | + |
| certifications.number | Certificate number | |
| certifications.text | Certificate full description | |
| certifications.uuid | Certificate identifier | + |
| color_uuids | List of color identifiers | |
| colors | List of colors | + |
| colors.term | Color label | + |
| colors.uuid | Color identifier | + |
| creation_date_text | Creation date full text | |
| creation_finish_year | Creation finish year | |
| creation_place_term | Label of creation place (with hierarchy) | + |
| creation_place_uuid | Creation place identifier | |
| creation_place_text | Creation place free text | |
| creation_start_year | Creation date start year | |
| description_text | Object full description text | |
| edition_text | Object edition full text | |
| edition_number | Edition number | |
| edition_size | Edition size | |
| edition_state_term | Edition state label | + |
| edition_state_uuid | Edition state identifier | |
| exhibition_history_text | Exhibition history text | |
| image_uuids | List of images identifiers | |
| images | List of object images | + |
| images.large_url | Large version url | + |
| images.medium_url | Medium version url | + |
| images.thumb_url | Thumbnail version url | + |
| images.url | Original url | + |
| images.uuid | Image identifier | + |
| images.zoom_url | Zoom version url | + |
| inscription_text | Inscription text | |
| literature_text | Literature text | |
| lot_uuids | List of lots identifiers | |
| lots | List of lots | + |
| makers | List of object makers | |
| makers.dates | Text with living/existence years | + |
| makers.modifier_uuid | Modifier identifier | |
| makers.modifier_term | Modifier label | |
| makers.name | Maker name/title | + |
| makers.uuid | Maker identifier | |
| material_uuids | List of materials identifiers | |
| materials | List of materials | + |
| materials.term | Material label | + |
| materials.uuid | Material identifier | + |
| materials_text | Full materials description text | |
| measurements | List of measurements | |
| measurements.type | Measurement type label | + |
| measurements.type_uuid | Measurement type identifier | |
| measurements.unit | Measurement unit label | + |
| measurements.unit_uuid | Measurement unit identifier | |
| measurements.value | Value | |
| measurements.value_normalized | Normalized value | + |
| measurements_text | Full measurements description text | |
| provenance_text | Object provenance text | |
| shape_uuids | List of shapes identifiers | |
| shapes | List of shapes | + |
| shapes.term | Shape label | + |
| shapes.uuid | Shape identifier | + |
| shown | Flag of object accessible | + |
| style_uuids | List of styles identifiers | |
| styles | List of styles | + |
| styles.term | Style label | + |
| styles.uuid | Style identifier | + |
| mark_count | Integer. Count of related marks | + |
| mark_uuids | List of related marks | |
| inserted_at | Datetime of creating record | + |
Jewelry
| Path of object field | Description | Read only |
|---|---|---|
| jewelry_type_term | Jewelry type label | + |
| jewelry_type_uuid | Jewelry type identifier | |
| jewelry_gem_setting_term | Gem setting label | + |
| jewelry_gem_setting_uuid | Gem setting identifier | |
| gem_uuids | List of objects-gems identifiers | |
| gem_objects | List of linked objects-gems | + |
| gem_count | Count of linked objects-gems | + |
Gems
| Path of object field | Description | Read only |
|---|---|---|
| gem_clarity_term | Gem clarity label | + |
| gem_clarity_uuid | Gem clarity identifier | |
| gem_color_intensity_term | Gem color intensity label | + |
| gem_color_intensity_uuid | Gem color intensity identifier | |
| gem_colourless | Gem colourless flag | |
| gem_cut_term | Gem cut label | + |
| gem_cut_uuid | Gem cut identifier | |
| gem_cut_grade_term | Gem cut grade label | + |
| gem_cut_grade_uuid | Gem cut grade identifier | |
| gem_treatment_degree_term | Gem treatment degree label | + |
| gem_treatment_degree_uuid | Gem treatment degree identifier | |
| gem_treatment_type_term | Gem treatment type label | + |
| gem_treatment_type_uuid | Gem treatment type identifier |
Marks
List Marks
curl "https://api.cdata.christies.tech/primus/marks/?usage_year_from=1953&api_key={API_KEY}"
{
"marks": [
{"uuid": "...", ...},
...
]
}
This endpoint retrieves list of marks matching the query parameters.
HTTP Request
GET https://api.cdata.christies.tech/primus/marks?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | Your API key |
| query | Full text search |
| uuids | List. Filter by uuids |
| type_uuids | List. Filter marks with types in the list |
| usage_year_from | Integer. Left margin of usage year |
| usage_year_to | Integer. Right margin of usage year |
| symbol_uuids | List. Filter marks with symbols in the list |
| shape_uuids | List. Filter marks with shapes in the list |
| cdata_category_uuids | List. Filter marks with categories in the list |
| place_uuids | List. Filter marks with places in the list |
| maker_uuids | List. Filter marks with makers in the list |
| material_uuids | List. Filter marks with materials in the list |
| letters | List. Filter marks with letters in the list |
Marks letters
This endpoint is helper for autosuggestion of existing letters which was added to all marks
curl "https://api.cdata.christies.tech/primus/marks/letters?query=X&api_key={API_KEY}"
["X", "XY", "XYZ"]
Find a Mark by UUID
curl "https://api.cdata.christies.tech/primus/marks/{UUID}?api_key={API_KEY}"
{"mark": {
"uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"title": "Mark of Rings",
"type_term": "bracelet",
"type_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"usage_year_from": 1910,
"usage_year_to": 1990,
"usage_year_text": "1910 - 1990",
"letters": ["A", "XX"],
"notes": [
"Maker's mark for Castellani. The two C's in relief on a plaque applied to the jewel. May have been in use from about 1861", "XX",
"Maker's mark of Atelier Sellier-Dumont. Found on jewels by Van Cleef & Arpels."
],
"symbol_uuids": ["7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551", "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab"],
"symbols": [
{
"uuid": "12e066b9-17dc-41d1-a1d9-7156ae7a7f66",
"term": "apple"
},
{
"uuid": "12e066b9-17dc-41d1-a1d9-7156ae7a7f66",
"term": "star"
}
],
"shape_uuids": ["7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551", "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab"],
"shapes": [
{
"uuid": "12e066b9-17dc-41d1-a1d9-7156ae7a7f66",
"term": "almond-shaped"
},
{
"uuid": "12e066b9-17dc-41d1-a1d9-7156ae7a7f66",
"term": "concave"
}
],
"cdata_category_uuids": ["7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551", "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab"],
"cdata_categories": [
{
"uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"term": "Paintings",
"parent_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"parent_term": "Fine Art"
},
{
"uuid": "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab",
"term": "Watches",
"parent_uuid": null,
"parent_term": null
}
]
"place_uuids": ["7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551", "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab"],
"places": [
{
"uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"name": "Paris",
"hierarchy": "Europe, France, Paris"
},
{
"uuid": "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab",
"name": "New York",
"hierarchy": "North America, USA, New York"
}
],
"maker_uuids": ["7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551", "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab"],
"makers": [
{
"uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551"
"name": "Andy Warhol",
},
{
"uuid": "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab"
"name": "Rolex",
}
],
"material_uuids": ["7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551", "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab"],
"materials": [
{
"uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"term": "silver"
},
{
"uuid": "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab",
"term": "gold"
}
]
"images": [
{
"uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"preferred": true,
"url": "http://some.image/pic.jpg",
"caption": "Nice mark",
"large_url": "http://some.image/large.jpg",
"medium_url": "http://some.image/medium.jpg",
"zoom_url": "http://some.image/zoom.jpg",
"thumb_url": "http://some.image/thumb.jpg"
},
{
"uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"preferred": false,
"url": "http://some.image/pic.jpg",
"caption": null,
"large_url": null,
"medium_url": null,
"zoom_url": null,
"thumb_url": null
}
],
"object_count": 3,
"inserted_at": "2019-02-07T07:19:00.845061Z"
}}
This endpoint retrieves a single mark by UUID.
HTTP Request
GET https://api.cdata.christies.tech/primus/marks/{UUID}?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | Your API key |
| UUID | The mark UUID |
The full list of response fields describe in a section Mark fields description.
Mark fields description
| Path of mark field | Description | Read only |
|---|---|---|
| uuid | String. Mark identifier | + |
| title | String. Mark title | |
| type_term | String. Mark type label | + |
| type_uuid | String. Mark type identifier | |
| usage_year_from | Integer. Start year of mark's usage | |
| usage_year_to | Integer. Finish year of mark's usage | |
| usage_year_text | String. Custom text of usage years. Default is {from} - {to} |
|
| letters | List of letters (no vocabulary, similar to tags) | |
| notes | List of notes | + |
| symbol_uuids | List of symbols identifiers | + |
| symbols | List of symbols | + |
| symbols.uuid | String. Symbol identifier | + |
| symbols.term | String. Symbol vocabulary label | + |
| shape_uuids | List of shapes identifiers | |
| shapes | List of shapes | + |
| shapes.uuid | String. Shape identifier | + |
| shapes.term | String. Shape vocabulary label | + |
| cdata_category_uuids | List of cdata categories identifiers | |
| cdata_categories | List of cdata categories | + |
| cdata_categories.uuid | String. Cdata Category identifier | + |
| cdata_categories.term | String. Cdata Category vocabulary label | + |
| place_uuids | List of origin places identifiers | |
| places | List of cdata categories | + |
| places.uuid | String. Place identifier | + |
| places.term | String. Place name | + |
| maker_uuids | List of makers identifiers (persons uuids + organization uuids) | |
| makers | List of cdata categories | + |
| makers.uuid | String. Maker identifier | + |
| makers.term | String. Maker name | + |
| material_uuids | List of materials identifiers | |
| materials | List of cdata categories | + |
| materials.uuid | String. Material identifier | + |
| materials.term | String. Material vocabulary name | + |
| images | List of images | |
| images.uuid | String. Image identifier | |
| images.preferred | Boolean. Mark this image as primary image (only for one of them) | |
| images.url | String. Image bas url | + |
| images.caption | String. Image caption | + |
| images.large_url | String. Large version url | + |
| images.medium_url | String. Medium version url | + |
| images.zoom_url | String. Zoom version url | + |
| images.thumb_url | String. Thumbnail version url | + |
| inserted_at | Datetime of creating record | + |
Sale
The following endpoints are available for querying Sales.
List Sales
curl "https://api.cdata.christies.tech/primus/sales?api_key={API_KEY}"
{
"sales": [
{"uuid": "...", ...},
...
]
}
This endpoint retrieves a list of sales.
HTTP Request
GET https://api.cdata.christies.tech/primus/sales?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| uuids | List. Filter by uuids |
| auction_house_uuids | List. Filter sales with auction_house_uuid in the list |
| min_sale_date | Date. Filter sales with date greater or equal |
| max_sale_date | Date. Filter sales with date less or equal |
| location_uuids | List. Filter sales with location_uuid in the list |
| number | List. Filter sales with number in the list |
| numbers | List. Filter sales with numbers in the list |
| query | String. Filter sales title |
Sorting fields
| Field | |
|---|---|
| start_date | Default, desc |
| number |
Find a Sale by UUID
curl "https://api.cdata.christies.tech/primus/sales/{UUID}?api_key={API_KEY}"
{
"sale": {
"uuid": "3218bcbd-2eb7-4136-85b5-2fd8bbe2b779",
"url": "http://auctions.selkirkauctions.com/auction-catalog/Winter-Eclectic-Auction-SL1022",
"title": "Winter Eclectic Auction",
"comments": ["comment", "another comment],
"start_date": "2018-01-20",
"shown": true,
"price_type": "Premium",
"number": "SL1022",
"location_uuid": "12065db8-7b7c-4611-9324-11bbf4a916c8",
"location_title": "Ivey-Selkirk Auctioneers - Saint Louis",
"image_url": null,
"finish_date": "2018-01-20",
"currency": "USD",
"auction_house_uuid": "376d2d2d-3282-47e1-a32c-727dabc151ea",
"auction_house_name": "Selkirk's"
}
}
This endpoint retrieves a single sale by UUID.
HTTP Request
GET https://api.cdata.christies.tech/primus/sales/{UUID}?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| UUID | String. The sale UUID |
Session
The following endpoints are available for querying Sessions.
List Sessions
curl "https://api.cdata.christies.tech/primus/sessions?api_key={API_KEY}"
{
"sessions": [
{"uuid": "...", ...},
...
]
}
This endpoint retrieves a list of sessions.
HTTP Request
GET https://api.cdata.christies.tech/primus/sessions?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| uuids | List. Filter by uuids |
| min_sale_date | Date. Filter sessions with date greater or equal |
| max_sale_date | Date. Filter sessions with date less or equal |
| location_uuids | List. Filter sessions with location_uuid in the list |
| sale_uuids | List. Filter sessions with sale_uuid in the list |
Find a Session by UUID
curl "https://api.cdata.christies.tech/primus/sessions/{UUID}?api_key={API_KEY}"
{
"session": {
"uuid": "e7f938b0-7ade-4131-97e3-53ee76106a6b",
"title": "Marine Pictures",
"status": "Created",
"start_time": null,
"start_date": "2006-09-12",
"sale_uuid": "90e15d5e-b662-4d12-a1c1-a4f740f4b48e",
"location_uuid": "489cf63f-2002-4992-9c65-961e491f3d85",
"last_lot_number": "106",
"first_lot_number": "1",
"finish_date": "2006-09-12",
"channel": "live"
}
}
This endpoint retrieves a single session by UUID.
HTTP Request
GET https://api.cdata.christies.tech/primus/sessions/{UUID}?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| UUID | String. The session UUID |
VocabularyItem
The following endpoints are available for querying VocabularyItems.
List VocabularyItems
curl "https://api.cdata.christies.tech/primus/vocabulary_items?api_key={API_KEY}"
{
"vocabulary_items": [
{"uuid": "...", ...},
...
]
}
This endpoint retrieves a list of vocabulary items.
HTTP Request
GET https://api.cdata.christies.tech/primus/vocabulary_items?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| vocabulary_id | Integer. Filter vocabulary_items with vocabulary_id |
| vocabulary_ids | List. Filter vocabulary_items with vocabulary_id in the list |
| vocabulary_item_mapping_uuid | String. Filter vocabulary_items with vocabulary_item_mapping_uid |
| vocabulary_sid | String. Filter vocabulary_items with vocabulary_sid |
| query | String. Filter vocabulary items with text |
Find a VocabularyItem by UUID
curl "https://api.cdata.christies.tech/primus/vocabulary_items/{UUID}?api_key={API_KEY}"
{
"vocabulary_item": {
"vocabulary_sid": "vocabulary_class_wine_spain_age",
"vocabulary_item_mappings": [
{
"vocabulary_sid": "vocabulary_entity_types",
"uuid": "af63145b-9fe5-4ad3-8c33-d3ac97c9cd6c",
"text": "wine",
"parent_uuid": null
}
],
"uuid": "a3bc4d60-3bd5-4bcd-9b0a-6cd0330ddb1d",
"text": "crianza",
"parent_uuid": null
}
}
This endpoint retrieves a single vocabulary item by UUID.
HTTP Request
GET https://api.cdata.christies.tech/primus/vocabulary_items/{UUID}?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| UUID | String. The VocablaryItem UUID |
Place
The following endpoints are available for querying Places.
List Places
curl "https://api.cdata.christies.tech/primus/places?api_key={API_KEY}"
{
"places": [
{"uuid": "...", ...},
...
]
}
This endpoint retrieves a list of places.
HTTP Request
GET https://api.cdata.christies.tech/primus/places?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| uuids | List. Filter by uuids |
| parent_uuid | String. Filter sales with parent_uuid in the list |
| query | String. Filter places title |
Place fields description
| Path of place field | Description | Read only |
|---|---|---|
| uuid | String. Place identifier | + |
| name | String. Name of place | |
| parent_uuid | String. Identifier of parent's place | |
| name_hierarchy | String. Full name of place by hierarchy | + |
Find a Place by UUID
curl "https://api.cdata.christies.tech/primus/places/{UUID}?api_key={API_KEY}"
{
"place": {
"uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"name": "Paris",
"name_hierarchy": "Europe, France, Paris",
"parent_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
}
}
This endpoint retrieves a single place by UUID.
HTTP Request
GET https://api.cdata.christies.tech/primus/places/{UUID}?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| UUID | String. The sale UUID |
Person
The following endpoints are available for querying People.
List People
curl "https://api.cdata.christies.tech/primus/people?api_key={API_KEY}"
{
"people": [
{"uuid": "...", ...},
...
]
}
This endpoint retrieves a list of people.
HTTP Request
GET https://api.cdata.christies.tech/primus/people?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| uuids | List. Filter by uuids |
| role_uuid | List. Filter people with role_uuid in the list |
| nationality_uuid | List. Filter people with nationality_uuid in the list |
| approved | List. Filter people with approved in the list |
| query | String. Filter people name |
Person fields description
| Path of person field | Description | Read only |
|---|---|---|
| uuid | String. Person identifier | + |
| name | String. Name of person | |
| approved | Boolean. Flag of data approved | + |
| nationality_uuid | String. Nationality identifier | |
| nationality_term | String. Nationality label | + |
| role_uuid | String. Role identifier | |
| role_term | String. Role label | + |
| existence_start_year | Integer. Year of birth | |
| existence_finish_year | Integer. Year of death | |
| existence_date_text | String. Free text of living dates | |
| image_uuid | String. Image identifier | |
| image_url | String. Image thumbnail url | + |
| disambiguating_comment | String. Text for disambiguating | |
| objects_count | Integer. Count of objects | + |
Find a Person by UUID
curl "https://api.cdata.christies.tech/primus/people/{UUID}?api_key={API_KEY}"
{
"person": {
"uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"name": "Andy Warhol",
"approved": true,
"nationality_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"nationality_term": "American",
"role_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"role_term": "Artist",
"existence_start_year": 1928,
"existence_finish_year": 1987,
"existence_date_text": "1928 - 1987",
"image_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"image_url": "https://s3.amazonaws.com/cdata-images-v2-production/images/13115557/thumbnail.jpg",
"disambiguating_comment": null,
"objects_count": 14235
}
}
This endpoint retrieves a single person by UUID.
HTTP Request
GET https://api.cdata.christies.tech/primus/people/{UUID}?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| UUID | String. The person UUID |
Organization
The following endpoints are available for querying Organizations.
List Organizations
curl "https://api.cdata.christies.tech/primus/organizations?api_key={API_KEY}"
{
"organizations": [
{"uuid": "...", ...},
...
]
}
This endpoint retrieves a list of organizations.
HTTP Request
GET https://api.cdata.christies.tech/primus/organizations?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| uuids | List. Filter by uuids |
| role_uuids | List. Filter organizations with role_uuid in the list |
| nationality_uuids | List. Filter organizations with nationality_uuid in the list |
| approved | List. Filter organizations with approved in the list |
| query | String. Filter organizations name |
Organization fields description
| Path of organization field | Description | Read only |
|---|---|---|
| uuid | String. Organization identifier | + |
| name | String. Name of organization | |
| approved | Boolean. Flag of data approved | + |
| nationality_uuid | String. Nationality identifier | |
| nationality_term | String. Nationality label | + |
| role_uuid | String. Role identifier | |
| role_term | String. Role label | + |
| existence_start_year | Integer. Year of founding | |
| existence_finish_year | Integer. Year of finishing organization's activity | |
| existence_date_text | String. Free text of founding | |
| image_uuid | String. Image identifier | |
| image_url | String. Image thumbnail url | + |
| disambiguating_comment | String. Text for disambiguating | |
| objects_count | Integer. Count of objects | + |
Find an Organization by UUID
curl "https://api.cdata.christies.tech/primus/organizations/{UUID}?api_key={API_KEY}"
{
"organization": {
"uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"name": "Rolex",
"approved": true,
"nationality_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"nationality_term": "Swiss",
"role_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"role_term": "Watchmaker",
"existence_start_year": null,
"existence_finish_year": null,
"existence_date_text": null,
"image_uuid": null,
"image_url": null,
"disambiguating_comment": null,
"objects_count": 45647
}
}
This endpoint retrieves a single organization by UUID.
HTTP Request
GET https://api.cdata.christies.tech/primus/organizations/{UUID}?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| UUID | String. The organization UUID |
Parsing
Parse artwork data
# curl request
$ curl https://api.cdata.christies.tech/primus/parsing?artist=Andy Warhol&api_key={API_KEY} -H "Content-Type: application/json"
{"cdata_category_term": "Fine Art", ..}
# Response example
{
"cdata_category_term": "Fine Art",
"cdata_category_uuid": "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab",
"cdata_subcategory_term": "Photographs",
"cdata_subcategory_uuid": "550237ff-64e7-40bb-866b-13c61258cad2",
"creation_date_text": null,
"creation_finish_year": null,
"creation_start_year": null,
"edition_size": null,
"edition_state_term": null,
"edition_state_uuid": null,
"edition_text": null,
"makers": [
{
"dates": "1928 - 1987",
"modifier_term": null,
"modifier_uuid": null,
"name": "Andy Warhol",
"type": "person",
"uuid": "a0316264-70a4-4c3e-a139-ad6cc7625432"
}
],
"materials": [],
"materials_text": null,
"measurements": [],
"measurements_text": null
}
HTTP Request
GET https://api.cdata.christies.tech/primus/parsing?artist=Andy Warhol&api_key={API_KEY}
# GET parameters
{
"api_key": "{your api key}",
"creation_date": "1960s",
"description": "Executed in oil on canvas, signed, inscribed and dated 'THE WAYS OF IT./12 gns/Camille Souter/Dooagh Achill/Co. Mayo'",
"inscription": "signed, inscribed and dated 'THE WAYS OF IT./12 gns/Camille Souter/Dooagh Achill/Co. Mayo'",
"edition": "Numbered 5/10, artist's proof",
"artist": "Andy Warhol (1928 - 1987)",
"sale_name": "Evening sale",
"title": "Marilyn",
"material": "oil on canvas",
"measurement": "30x50 in",
"provenance": "Christie's, New York, December 31 2000, Lot 1"
}
GET Parameters
All parameters are optional
| Parameter | Description |
|---|---|
| api_key | String. Api key |
| creation_date | String. Creation date |
| description | String. Artwork description |
| inscription | String. Artwork inscription |
| edition | String. Artwork edition |
| artist | String. Creator name |
| sale_name | String. Sale title |
| title | String. Artwork title |
| material | String. Artwork materials |
| measurement | String. Artwork dimensions |
| provenance | String. Artwork provenance text |
Response fields
Look to example of response.
Set
The following endpoints are available for querying Sets.
List Sets
curl "https://api.cdata.christies.tech/primus/sets?api_key={API_KEY}"
{
"sets": [
{"uuid": "...", ...},
...
]
}
This endpoint retrieves a list of sets.
HTTP Request
GET https://api.cdata.christies.tech/primus/sets?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| object_uuids | List. Filter by object uuids |
Find a Set by UUID
curl "https://api.cdata.christies.tech/primus/sets/{UUID}?api_key={API_KEY}"
{
"set": {
"uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
"name": "New Set",
"object_uuids": ["7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551", "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551"],
}
}
This endpoint retrieves a single set by UUID.
HTTP Request
GET https://api.cdata.christies.tech/primus/sets/{UUID}?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| UUID | String. The set UUID |
Spectrum
The following endpoints are available for querying Spectrum.
Get Spectrum artist price indexes
curl "https://api.cdata.christies.tech/primus/spectrum/price_indexes?api_key={API_KEY}"
[
{
"artist_uuids": ["4b342abc-8204-4e3d-8171-1268b9ed5fdf"],
"name": "Gerhard Richter Paintings",
...
},
...
]
This endpoint retrieves list of artist price indexes.
HTTP Request
GET https://api.cdata.christies.tech/primus/spectrum/price_indexes?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
Get Spectrum results
curl "https://api.cdata.christies.tech/primus/spectrum/results?api_key={API_KEY}"
[
{
"model_name": "..",
...
},
...
]
This endpoint retrieves list of spectrum results.
HTTP Request
GET https://api.cdata.christies.tech/primus/spectrum/results?api_key={API_KEY}
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key. |
| id | Integer. Spectrum result id. |
| lot_id | Integer. Lot id to filter results. |
Image
The following endpoints are available for image related endpoints.
Extract image colors using a predefined palette.
curl "https://api.cdata.christies.tech/primus/images/extract_colors?api_key={API_KEY}&image_url=http://..."
{
"colors": [
{
"class": "orange",
"hex": "#ffcc99",
"rank": 1,
"rgb": [255, 204, 153],
"weight": 39.21
},
{
"class": "purple",
"hex": "#ff0066",
"rank": 2,
"rgb": [255, 0, 102],
"weight": 32.83
},
{
"class": "black",
"hex": "#000000",
"rank": 3,
"rgb": [0, 0, 0],
"weight": 25.63
},
{
"class": "yellow",
"hex": "#cccc00",
"rank": 4,
"rgb": [204, 204, 0],
"weight": 2.32
},
{
"class": "green",
"hex": "#666633",
"rank": 5,
"rgb": 'ff3',
"weight": 0.01
}
]
}
This endpoint extracts the dominant colors from an image, provided by URL, and matches the results to a predefined palette.
HTTP Request
GET https://api.cdata.christies.tech/primus/images/extract_colors?api_key={API_KEY}&image_url=http://...
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| image_url | URL of the image to extract colors from |
Extract dominant image colors
curl "https://api.cdata.christies.tech/primus/images/extract_raw_colors?api_key={API_KEY}&image_url=http://..."
{
"colors": [
{
"hex": "#ffcc99",
"rank": 1,
"rgb": [255, 204, 153],
"weight": 39.21
},
{
"hex": "#ff0066",
"rank": 2,
"rgb": [255, 0, 102],
"weight": 32.83
},
{
"hex": "#000000",
"rank": 3,
"rgb": [0, 0, 0],
"weight": 25.63
},
{
"hex": "#cccc00",
"rank": 4,
"rgb": [204, 204, 0],
"weight": 2.32
},
{
"hex": "#666633",
"rank": 5,
"rgb": 'ff3',
"weight": 0.01
}
]
}
This endpoint extracts the dominant colors from an image, provided by URL, and returns the exact matched colors.
HTTP Request
GET https://api.cdata.christies.tech/primus/images/extract_raw_colors?api_key={API_KEY}&image_url=http://...
URL Parameters
| Parameter | Description |
|---|---|
| api_key | String. Your API key |
| image_url | URL of the image to extract colors from |
API Types
| Type | Meaning |
|---|---|
| List | A list of integers or strings. Example: [1, 2, 3]. |
| Date | A string in the format 'yyyy-mm-dd'. |
| Image | A binary image (jpg/png/gif), uploaded with multipart/form-data encoding. |
| * | A required param |
Errors
The API uses the following error codes:
| Code | Meaning |
|---|---|
| 400 | Bad Request - Your request is invalid. |
| 401 | Unauthorized - Your API key is wrong. |
| 404 | Not Found - The specified entity could not be found. |
| 405 | Method Not Allowed - You tried to access a entity with an invalid method. |
| 500 | Internal Server Error - We had a problem with our server. Try again later. |