ETH Zurich – Swiss Federal Institute of Technology provenance items API

openapi: 3.0.2
info:
  title: Discovery bitstreams provenance items API
  description: "The Discovery REST API provides access to over 30 million books, images, series, journals, and other materials from the ETH Library's Discovery Portal. \n\n➜ [OAS 3 Swagger Documentation](https://eth-library.github.io/apiplatform-swagger/discovery/v1/)\n\n➜ [ETH Library @ swisscovery Application](https://eth.swisscovery.slsp.ch/)"
  version: 1.0.2
  termsOfService: https://developer.library.ethz.ch/terms
  contact:
    name: API Management ETH Library
    email: api@library.ethz.ch
    url: https://library.ethz.ch
  license:
    url: https://developer.library.ethz.ch/terms
    name: Bibliographic metadata that are not specifically marked are free for general use (Public Domain). Documents, images or other digital objects linked in metadata may be subject to other copyright restrictions. Whenever possible, the licence of the referenced digital objects is indicated in the metadata. In case of doubt, the licence can be inquired at api@library.ethz.ch.
servers:
- url: https://api.library.ethz.ch/discovery/v1/
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: provenance items
paths:
  /provenance-items:
    get:
      tags:
      - provenance items
      description: Returns images (provenances) from E-Pics catalogue "Ex meis libris".
      parameters:
      - name: q
        schema:
          type: string
        in: query
        required: false
        description: 'Returns the images for the search term (q).


          Example: q=bern'
      - name: lat
        schema:
          type: number
        in: query
        required: false
        description: 'Returns images (provenances) for a point from the E-Pics catalog “Ex meis libris”. The point is defined by lat (latitude) and long (longitude) and optionally dist (radius) in meters (default: 1000).


          Example: lat=47.349952'
      - name: lon
        schema:
          type: number
        in: query
        required: false
        description: 'Returns images (provenances) for a point from the E-Pics catalog “Ex meis libris”. The point is defined by lat (latitude) and long (longitude) and optionally dist (radius) in meters (default: 1000).'
        Example: lon=8.490838
      - name: dist
        schema:
          type: number
        in: query
        required: false
        description: 'Returns images (provenances) for a point from the E-Pics catalog “Ex meis libris”. The point is defined by lat (latitude) and long (longitude) and optionally dist (radius) in meters (default: 1000).


          Example: dist=1000'
      - name: edges
        schema:
          type: boolean
        in: query
        required: false
        description: 'Should the edges/relations to e-rara also be returned (default: true)?


          Example: edges=false'
      responses:
        '200':
          description: Returns images (provenances) from E-Pics catalogue "Ex meis libris"
          content:
            application/json: {}
        '400':
          description: bad request
        '500':
          description: server error
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: query
      name: apikey
externalDocs:
  description: OAS 3 Swagger Documentation
  url: https://apidocs.library.ethz.ch/discovery/v1/