openapi: 3.1.0
info:
title: Artsy Public Applications Editions API
version: 2.0.0
description: 'The Artsy Public API (v2) is a HAL (Hypertext Application Language) hypermedia REST API that provides access to Artsy''s database of artists, artworks, genes (Art Genome Project categories), shows, partners, fairs, and auction sales. Authentication uses an application-level X-Xapp-Token obtained by exchanging a client_id and client_secret. NOTE: Artsy has announced that the public API is being retired and may be taken down without notice; the Partner API remains for approved partners.
Derived by API Evangelist from the live HAL root at https://api.artsy.net/api and the published documentation at https://developers.artsy.net/.'
termsOfService: https://www.artsy.net/api-terms
contact:
name: Artsy Developers
url: https://developers.artsy.net/
x-apievangelist-note: Derived from live HAL discovery + docs; not published by Artsy as OpenAPI.
servers:
- url: https://api.artsy.net/api
description: Artsy Public API v2
security:
- XappToken: []
tags:
- name: Editions
paths:
/editions/{id}:
get:
operationId: getEdition
summary: Get an edition
tags:
- Editions
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: artwork_id
in: query
required: false
description: Filter by artwork id.
schema:
type: string
responses:
'200':
description: An edition
content:
application/json:
schema:
$ref: '#/components/schemas/HALResource'
'404':
$ref: '#/components/responses/Error'
components:
schemas:
HALResource:
type: object
description: A HAL resource with hypermedia _links and _embedded relations.
properties:
id:
type: string
_links:
type: object
_embedded:
type: object
Error:
type: object
properties:
type:
type: string
description: Error category, e.g. auth_error, param_error, other_error.
message:
type: string
description: Human-readable error message.
detail:
type: object
description: Optional per-field validation detail.
responses:
Error:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
XappToken:
type: apiKey
in: header
name: X-Xapp-Token
description: Application-level token obtained from POST /tokens/xapp_token by exchanging client_id and client_secret. Sent in the X-Xapp-Token request header.