NAV Navigation
shell

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_key query string variable:

curl "/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

# curl request with bad email / password
$ curl /api.cdata.christies.com/services/login -H "Content-Type: application/json" -d '{"email":"bad@email.com","password":"xyz"}'
{"message":"Could not login"}
# curl request with correct email / password
$ curl /api.cdata.christies.com/services/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).

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 /api.cdata.christies.com/services/login

# POST parameters
{
  "email": "correct@email.com",
  "password": "xyz"
}

POST Parameters

Parameter Description
email 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 /api.cdata.christies.com/services/logout -X "DELETE" -H "authorization: Bearer {your api key}"

HTTP Request

DELETE /api.cdata.christies.com/services/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 "/api.cdata.christies.tech/services/auction_houses?api_key={API_KEY}"
{
  "auction_houses": [
    {"uuid": "...", ...},
    ...
  ]
}

This endpoint retrieves a list of auction houses.

HTTP Request

GET /api.cdata.christies.tech/services/auction_houses?api_key={API_KEY}

URL Parameters

Parameter Description
api_key String. Your API key
query String. Filter auction houses title

Find an Auction House by UUID

curl "/api.cdata.christies.tech/services/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 /api.cdata.christies.tech/services/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 "/api.cdata.christies.tech/services/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 /api.cdata.christies.tech/services/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 "/api.cdata.christies.tech/services/locations?api_key={API_KEY}"
{
  "locations": [
    {"uuid": "...", ...},
    ...
  ]
}

This endpoint retrieves list of locations matching the query parameters.

HTTP Request

GET /api.cdata.christies.tech/services/locations?api_key={API_KEY}

URL Parameters

Parameter Description
api_key String. Your API key
auction_house_uuids List. Filter locaations with auction_house_uuid in the list
query String. Filter locatoins with title

Find a Location by UUID

curl "/api.cdata.christies.tech/services/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 /api.cdata.christies.tech/services/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.

List lots

curl "/api.cdata.christies.tech/services/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 /api.cdata.christies.tech/services/lots?api_key={API_KEY}

URL Parameters

Parameter Description
api_key String. Your API key
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_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
exclude_auction_houses Boolean. Filter lots without auction_house_uuid in the list
maker_qualifier_uuids List. Filter lots with maker_qualifier_uuid in the list
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_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
sale_location_uuids List. Filter lots with location in the list
sale_country_uuids List. Filter lots with country in the list
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

Find a lot by UUID

curl "/api.cdata.christies.tech/services/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_usd": 242.64,
      "price_premium": 132,
      "price_hammer": null,
      "price": 132,
      "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",
              "shown": true,
              "provenance": null,
              "medium": null,
              "measurements_text": null,
              "measurements": [],
              "materials_text": null,
              "materials": [],
              "makers": [],
              "inscription": null,
              "images": [],
              "exhibition_history": null,
              "edition": null,
              "description": null,
              "creation_start_year": null,
              "creation_finish_year": null,
              "creation_date_text": null,
              "cdata_subcategory_uuid": "f21f94a0-f691-4ec6-9433-2a413b009892",
              "cdata_subcategory_text": "Silver",
              "cdata_category_uuid": "ec048ec2-1da1-4ed5-a867-5f493ecdabe9",
              "cdata_category_text": "Furniture and Decorative Arts"
          }
      ],
      "number": "0257",
      "is_premium_price": true,
      "id": 10512486,
      "estimate_low_usd": 0,
      "estimate_low": 0,
      "estimate_high_usd": 0,
      "estimate_high": 0,
      "description": null,
      "bought_in_at_usd": null,
      "bought_in_at": null,
      "auction_house_uuid": "5dcadd63-cc05-4532-9071-53cfa3fcd565"
  }
}

This endpoint retrieves a single lot by UUID.

HTTP Request

GET /api.cdata.christies.tech/services/lots/{UUID}?api_key={API_KEY}

URL Parameters

Parameter Description
api_key String. Your API key
UUID String. The lot UUID

Lots stats

curl "/api.cdata.christies.tech/services/lots/stats?api_key={API_KEY}&auction_house_uuids[]={UUID}&maker_uuids[]={UUID}&maker_qualifier_uuids[]=null"
{
  "stats": {
    "totals": {
      "overall": {
        "price_premium_usd": 123,
        "price_hammer_usd": 345,
        "estimate_low_usd": 456,
        "estimate_high_usd": 567
      },
      "ROM": {
        "price_premium_usd": 123,
        "price_hammer_usd": 345,
        "estimate_low_usd": 456,
        "estimate_high_usd": 567
      },
      "Christie's": {
        "price_premium_usd": 123,
        "price_hammer_usd": 234,
        "estimate_low_usd": 345,
        "estimate_high_usd": 456
      },
      "Bonhams": {
        "price_premium_usd": 123,
        "price_hammer_usd": 234,
        "estimate_low_usd": 345,
        "estimate_high_usd": 456
      }
    },
    "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 /api.cdata.christies.tech/services/lots/stats?api_key={API_KEY}

URL Parameters

Parameters is equal to List lots section

Lots stats v2

curl "/api.cdata.christies.tech/services/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 /api.cdata.christies.tech/services/lots/stats/v2?api_key={API_KEY}

URL Parameters

Parameters is equal to 7205558344 section

Similar

curl "/api.cdata.christies.tech/services/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 /api.cdata.christies.tech/services/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 "/api.cdata.christies.tech/services/makers?api_key={API_KEY}"
{
  "makers": [
    {"uuid": "...", ...},
    ...
  ]
}

This endpoint retrieves list of makers matching the query parameters.

HTTP Request

GET /api.cdata.christies.tech/services/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 objtects_count
role_uuids List. Filter makers with role_uuid in the list
type String. Filter makers with type

Match Makers

curl "/api.cdata.christies.tech/services/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 /api.cdata.christies.tech/services/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 "/api.cdata.christies.tech/services/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"
    }
  }

This endpoint retrieves a single maker by UUID.

HTTP Request

GET /api.cdata.christies.tech/services/makers/{UUID}?api_key={API_KEY}

URL Parameters

Parameter Description
api_key String. Your API key
UUID String. The maker UUID

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 "/api.cdata.christies.tech/services/objects/?creation_year_from=1953&api_key={API_KEY}"
{
  "objects": [
    {"uuid": "...", ...},
    ...
  ]
}

This endpoint retrieves list of objects matching the query parameters.

HTTP Request

GET /api.cdata.christies.tech/services/objects?api_key={API_KEY}

URL Parameters

Parameter Description
api_key Your API key
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
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. Filter objects with images
has_no_images Boolean. Filter objects without images
has_makers Boolean. Filter objects with makers
has_no_makers Boolean. 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

Match Objects

curl -F "image=@/path/to/image.jpg" -F "api_key={API_KEY}" /api.cdata.christies.tech/services/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": "/s3.amazonaws.com/cdata-images-v2-production/images/1206484/large.jpg",
      "medium_url": "/s3.amazonaws.com/cdata-images-v2-production/images/1206484/medium.jpg",
      "thumb_url": "/s3.amazonaws.com/cdata-images-v2-production/images/1206484/thumbnail.jpg",
      "zoom_url": "/s3.amazonaws.com/cdata-images-v2-production/images/1206484/zoom.jpg"
    }],
    "inscription": "Con sello en la parte posterior "Fill in your own signature"",
    "lots": [{
        "auction_house_uuid": "f95ec158-4a3a-4829-a0d1-61f95a2968ac",
        "bought_in_at": null,
        "bought_in_at_usd": null,
        "description": "ANDY WARHOL, 11.27: Marilyn Monroe, Con sello en la parte posterior "Fill in your own signature", Serigrafía, 91 x 91 cm",
        "estimate_high": 12000.0,
        "estimate_high_usd": 688.32,
        "estimate_low": 9000.0,
        "estimate_low_usd": 516.24,
        "id": 5403859,
        "implied_bids_low_estimate": 2,
        "implied_bids_reserve": 4,
        "is_premium_price": true,
        "number": "43",
        "price": 10000.0,
        "price_hammer": 10000.0,
        "price_hammer_usd": 573.6,
        "price_premium": null,
        "price_premium_usd": null,
        "price_usd": 573.6,
        "sale_number": "783",
        "sale_title": "Subasta De Arte Moderno Y ContemporáNeo",
        "sale_uuid": "5be0344b-3225-41aa-bf94-0f5c0ca403fd",
        "session_finish_date": "2016-04-21",
        "session_start_date": "2016-04-21",
        "session_uuid": "1ff38738-5aed-4c4a-be8e-1b41485f35c0",
        "shown": true,
        "source": null,
        "source_id": null,
        "status": "Sold",
        "status_uuid": "d5a4b37e-888d-446b-98a2-aa9e8f87e54b",
        "title": "Marilyn Monroe",
        "uuid": "8304ef1c-b97e-4a53-a09a-67864f560087"
      },
      {
        "auction_house_uuid": "18f60213-8d89-4d72-96d0-117275778886",
        "bought_in_at": null,
        "bought_in_at_usd": null,
        "description": "ANDY WARHOL, 11.27: Marilyn Monroe, Con sello en la parte posterior "Fill in your own signature", Serigrafía, 91 x 91 cm",
        "estimate_high": 250000.0,
        "estimate_high_usd": 250000.0,
        "estimate_low": 150000.0,
        "estimate_low_usd": 150000.0,
        "id": 9276327,
        "implied_bids_low_estimate": 5,
        "implied_bids_reserve": 7,
        "is_premium_price": true,
        "number": "102",
        "price": 231750.0,
        "price_hammer": 185400.0,
        "price_hammer_usd": 185400.0,
        "price_premium": 231750.0,
        "price_premium_usd": 231750.0,
        "price_usd": 231750.0,
        "sale_number": "1503",
        "sale_title": "Modern & Contemporary Works of Art",
        "sale_uuid": "ac302f1d-5307-4c0d-b902-9ef7e9622d6f",
        "session_finish_date": "2014-11-03",
        "session_start_date": "2014-11-03",
        "session_uuid": "6fcb3af2-55af-492e-b8ab-606cdb0bb2b2",
        "shown": true,
        "source": null,
        "source_id": null,
        "status": "Sold",
        "status_uuid": "d5a4b37e-888d-446b-98a2-aa9e8f87e54b",
        "title": "Marilyn Monroe",
        "uuid": "417dd5f2-dbe1-42c7-9c3a-1ce46233ae18"
      }
    ],
    "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"
  },
  "upcoming_lots": []
}

This endpoint retrieves list of objects matching the image and query parameters.

HTTP Request

POST /api.cdata.christies.tech/services/objects/match

URL Parameters

Parameter Description
api_key String. Your API key
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 "/api.cdata.christies.tech/services/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)",
      "status_uuid": "d5a4b37e-888d-446b-98a2-aa9e8f87e54b",
      "status": "Sold",
      "source_id": null,
      "source": "christies",
      "shown": true,
      "session_uuid": "e50598d6-164c-4a02-b636-fd5dac0f4f39",
      "session_start_date": "1995-09-16",
      "session_finish_date": "1995-09-16",
      "sale_uuid": "17a3abf8-db51-42a7-bb8e-9cb14f1abf5b",
      "sale_title": "Property from the Collection of the Denver Art Museum",
      "price_usd": 1495.0,
      "price_premium_usd": 1495.0,
      "price_premium": 1495.0,
      "price_hammer_usd": null,
      "price_hammer": null,
      "price": 1495.0,
      "number": "0018",
      "is_premium_price": true,
      "id": 9696913,
      "estimate_low_usd": 500.0,
      "estimate_low": 500.0,
      "estimate_high_usd": 700.0,
      "estimate_high": 700.0,
      "description": "ATTRIBUTED ALFRED CORNELIUS HOWLAND (1838-1909)Street in a Rural Townoil on canvas13 x 17in. (33 x 43.2cm.)",
      "bought_in_at_usd": null,
      "bought_in_at": null,
      "auction_house_uuid": "5dcadd63-cc05-4532-9071-53cfa3fcd565"
    }],
    "inscription_text": null,
    "images": [{
      "uuid": "5dcadd63-cc05-4532-9071-53cfa3fcd565",
      "url": "/s3.amazonaws.com/cdata-images-v2-production/images/507985/original.jpg",
      "large_url": "/s3.amazonaws.com/cdata-images-v2-production/images/507985/large.jpg",
      "medium_url": "/s3.amazonaws.com/cdata-images-v2-production/images/507985/medium.jpg",
      "thumb_url": "/s3.amazonaws.com/cdata-images-v2-production/images/507985/thumbnail.jpg",
      "zoom_url": "/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,
    "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",
    "gem_count": 0,
    "gem_uuids": [],
    "gem_objects": [],
    "jewelry_price_per_carat_usd": 10000,
    "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",
  }
}

This endpoint retrieves a single object by UUID.

HTTP Request

GET /api.cdata.christies.tech/services/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
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 idendifier
⁣ ⁣ ⁣ ⁣ 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 idenifier +
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_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
⁣ ⁣ ⁣ ⁣ (323) 888-8058 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 accesable +
style_uuids List of styles identifiers
styles List of styles +
⁣ ⁣ ⁣ ⁣ styles.term Style label +
⁣ ⁣ ⁣ ⁣ styles.uuid Style identifier +
title Object title
uuid Object identifier +

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
jewelry_price_per_carat_usd Automatically calculated price per carat +
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

Manage an Object

Create an Object

curl /api.cdata.christies.tech/services/objects -d '{"title": "The New Object", "cdata_subcategory_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551"}' -H "authorization: Bearer {your api key} -H "Content-Type: application/json"

HTTP Request

POST /api.cdata.christies.tech/services/objects

The full list of POST parameters is described in the Object fields description section.

Only parameters not marked as Read only will be used.

Required parameters:

# POST parameters example
{
  "title": "Lady in Red",
  "cdata_subcategory_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551"
}
# Response example
{
  "object": {
    "title": "Lady in Red",
    "cdata_subcategory_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
    ...
  }
}

Response is equal to Find an Object by UUID

Delete an Object

curl /api.cdata.christies.tech/services/objects/{object uuid} -X DELETE -H "authorization: Bearer {your api key} -H "Content-Type: application/json"

HTTP Request

DELETE /api.cdata.christies.tech/services/objects/{object uuid}

HTTP Reponse

HTTP code 204 with empty of a body

Update an Object

curl /api.cdata.christies.tech/services/objects/{object uuid} -X PUT -d '{"title": "The New Title of Object"}' -H "authorization: Bearer {your api key} -H "Content-Type: application/json"

HTTP Request

PUT /api.cdata.christies.tech/services/objects/{object uuid}

The full list of POST parameters describe in a section (601) 401-3425.

You can use only parameters which not marked as Read only. Another parameters will be ignored.

Parameter cdata_subcategory_uuid should be equal to uuid Jewelry or Gems from the vocabulary CDATA Categories

# PUT parameters example
{
  "title": "Lady in Red",
}
# Response example
{
  "object": {
    "title": "Lady in Red",
    "cdata_subcategory_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
    ...
  }
}

Response is equal to 7738161002

Manage a Mark

Create a Mark

curl /api.cdata.christies.tech/services/marks -d '{"title": "The New Mark", "type_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551"}' -H "authorization: Bearer {your api key} -H "Content-Type: application/json"

HTTP Request

POST /api.cdata.christies.tech/services/marks

Only parameters not marked as Read only will be used.

# POST parameters example
{
  "title": "Mark of Rings",
  "type_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
  "usage_year_from": 1910,
  "usage_year_to": 1990,
  "usage_year_text": "1910 - 1990",
  "shape_uuids": ["7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551", "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab"],
  "cdata_category_uuids": ["7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551", "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab"],
  "place_uuids": ["7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551", "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab"],
  "maker_uuids": ["7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551", "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab"],
  "material_uuids": ["7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551", "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab"],
  "letters": ["A", "FC"],
  "images": [
    {"uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551", preferred: true},
    {"uuid": "6b9d9132-8b0d-4ce2-89e0-1f5c945827ab"},
  ],
}
# Response example
{
  "mark": {
    "uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
  }
}

Mark fields description

Path of mark field Description Read only
uuid String. Mark identifier +
title String. Mark title
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}
shape_uuids List of shapes identifiers
cdata_category_uuids List of cdata categories identifiers
place_uuids List of origin places identifiers
maker_uuids List of makers identifiers (persons uuids + organization uuids)
material_uuids List of materials identifiers
letters List of mark letters
images List of images
⁣ ⁣ ⁣ ⁣ images.uuid String. Image identifier
⁣ ⁣ ⁣ ⁣ images.preferred Boolean. Mark this image as primary image (only for one of them)

Sale

The following endpoints are available for querying Sales.

List Sales

curl "/api.cdata.christies.tech/services/sales?api_key={API_KEY}"
{
  "sales": [
    {"uuid": "...", ...},
    ...
  ]
}

This endpoint retrieves a list of sales.

HTTP Request

GET /api.cdata.christies.tech/services/sales?api_key={API_KEY}

URL Parameters

Parameter Description
api_key String. Your API key
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
query String. Filter sales title

Find a Sale by UUID

curl "/api.cdata.christies.tech/services/sales/{UUID}?api_key={API_KEY}"
  {
    "sale": {
      "uuid": "3218bcbd-2eb7-4136-85b5-2fd8bbe2b779",
      "url": "/auctions.selkirkauctions.com/auction-catalog/Winter-Eclectic-Auction-SL1022",
      "title": "Winter Eclectic Auction",
      "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 /api.cdata.christies.tech/services/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 "/api.cdata.christies.tech/services/sessions?api_key={API_KEY}"
{
  "sessions": [
    {"uuid": "...", ...},
    ...
  ]
}

This endpoint retrieves a list of sessions.

HTTP Request

GET /api.cdata.christies.tech/services/sessions?api_key={API_KEY}

URL Parameters

Parameter Description
api_key String. Your API key
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 "/api.cdata.christies.tech/services/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 /api.cdata.christies.tech/services/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 "/api.cdata.christies.tech/services/vocabulary_items?api_key={API_KEY}"
{
  "vocabulary_items": [
    {"uuid": "...", ...},
    ...
  ]
}

This endpoint retrieves a list of vocabulary items.

HTTP Request

GET /api.cdata.christies.tech/services/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 "/api.cdata.christies.tech/services/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 /api.cdata.christies.tech/services/vocabulary_items/{UUID}?api_key={API_KEY}

URL Parameters

Parameter Description
api_key String. Your API key
UUID String. The VocablaryItem UUID

Manage an Image

Create an Image

curl /api.cdata.christies.tech/services/images -d '{"caption": "Lady in Red", "url": "/some.image/url.jpeg"}' -H "authorization: Bearer {your api key} -H "Content-Type: application/json"

HTTP Request

POST /api.cdata.christies.tech/services/images

# POST parameters example / create by remote url
{
  "caption": "Lady in Red",
  "source": "/ru.wikipedia.org/wiki/The_Lady_in_Red",
  "url": "/some.image/url.jpeg"
}
# Response example
{
  "image": {
    "uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
    "url": "/s3.amazonaws.com/cdata-images-v2-production/images/9809219/original.jpg",
  }
}

Update an Image

Only fields: caption, source can be changed

curl /api.cdata.christies.tech/services/images -d '{"caption": "Lady in Red", "source": "/ru.wikipedia.org/wiki/The_Lady_in_Red"}' -H "authorization: Bearer {your api key} -H "Content-Type: application/json"

HTTP Request

PUT /api.cdata.christies.tech/services/images/{image uuid}

# POST parameters example
{
  "caption": "Lady in Red",
  "source": "/ru.wikipedia.org/wiki/The_Lady_in_Red",
}
# Response example
{
  "image": {
    "uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
    "url": "/s3.amazonaws.com/cdata-images-v2-production/images/9809219/original.jpg",
  }
}

Place

The following endpoints are available for querying Places.

List Places

curl "/api.cdata.christies.tech/services/places?api_key={API_KEY}"
{
  "places": [
    {"uuid": "...", ...},
    ...
  ]
}

This endpoint retrieves a list of places.

HTTP Request

GET /api.cdata.christies.tech/services/places?api_key={API_KEY}

URL Parameters

Parameter Description
api_key String. Your API key
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 "/api.cdata.christies.tech/services/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 /api.cdata.christies.tech/services/places/{UUID}?api_key={API_KEY}

URL Parameters

Parameter Description
api_key String. Your API key
UUID String. The sale UUID

Manage a Place

Create a Place

curl /api.cdata.christies.tech/services/places -d '{"name": "Paris", "parent_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551"}' -H "authorization: Bearer {your api key} -H "Content-Type: application/json"

HTTP Request

POST /api.cdata.christies.tech/services/places

Only parameters not marked as Read only will be used.

Required parameters:

# POST parameters example
{
  "name": "Paris",
  "parent_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
}
# Response example
{
  "place": {
    "uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
    "name": "Paris",
    "name_hierarchy": "Europe, France, Paris",
    "parent_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
  }
}

Person

The following endpoints are available for querying People.

List People

curl "/api.cdata.christies.tech/services/people?api_key={API_KEY}"
{
  "people": [
    {"uuid": "...", ...},
    ...
  ]
}

This endpoint retrieves a list of people.

HTTP Request

GET /api.cdata.christies.tech/services/people?api_key={API_KEY}

URL Parameters

Parameter Description
api_key String. Your API key
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 "/api.cdata.christies.tech/services/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": "/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 /api.cdata.christies.tech/services/people/{UUID}?api_key={API_KEY}

URL Parameters

Parameter Description
api_key String. Your API key
UUID String. The person UUID

Manage a Person

Create a Person

curl /api.cdata.christies.tech/services/people -d '{"name": "Andy Warhol", "role_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551"}' -H "authorization: Bearer {your api key} -H "Content-Type: application/json"

HTTP Request

POST /api.cdata.christies.tech/services/people

Only parameters not marked as Read only will be used.

Required parameters:

# POST parameters example
{
  "name": "Andy Warhol",
  "role_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
  "nationality_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
}
# Response example
{
  "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": "/s3.amazonaws.com/cdata-images-v2-production/images/13115557/thumbnail.jpg",
    "disambiguating_comment": null,
    "objects_count": 14235
  }
}

Organization

The following endpoints are available for querying Organizations.

List Organizations

curl "/api.cdata.christies.tech/services/organizations?api_key={API_KEY}"
{
  "organizations": [
    {"uuid": "...", ...},
    ...
  ]
}

This endpoint retrieves a list of organizations.

HTTP Request

GET /api.cdata.christies.tech/services/organizations?api_key={API_KEY}

URL Parameters

Parameter Description
api_key String. Your API key
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 "/api.cdata.christies.tech/services/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 /api.cdata.christies.tech/services/organizations/{UUID}?api_key={API_KEY}

URL Parameters

Parameter Description
api_key String. Your API key
UUID String. The organization UUID

Manage a Organization

Create a Organization

curl /api.cdata.christies.tech/services/organizations -d '{"name": "Rolex", "role_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551"}' -H "authorization: Bearer {your api key} -H "Content-Type: application/json"

HTTP Request

POST /api.cdata.christies.tech/services/organizations

Only parameters not marked as Read only will be used.

Required parameters:

# POST parameters example
{
  "name": "Rolex",
  "role_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
  "nationality_uuid": "7e1f3c5b-71bf-4a62-ae83-e5c9a48e2551",
}
# Response example
{
  "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
  }
}

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.