I/O Docs for the ZEIT ONLINE Content API

• Author

  • List Methods
  • Expand Methods

  • GETSearch all authors/author
    This endpoint lets you search for authors by their name. An asterisk can serve as a wildcard or whitespace in your search query.
    
    

    Parameter	Value	Type	Description
    q		string	the main search query
    fields		string	partially select output fields
    limit		string	amount of matches to return
    offset		string	offset for the list of matches

  • GETGet author (articles) by ID/author/:id
    This endpoint provides a pre-filtered search for all articles written by a specific author. Deeper queries, pagination and partial field selection can be used to narrow down the match list.
    
    

    Parameter	Value	Type	Description
    id		string	ID of the author
    q		string	the main search query
    fields		string	partially select output fields
    limit		string	amount of matches to return
    offset		string	offset for the list of matches

• Client

  • List Methods
  • Expand Methods

  • GETObserve your usage/client
    The user endpoint is not a content resource per se, but lets you get information about your API usage.
    
    

• Content

  • List Methods
  • Expand Methods

  • GETSearch for content/content
    This endpoint lets you search for articles freely. You can set search queries, link them logically, paginate and partially select the fields, that should be returned.
    
    

    Parameter	Value	Type	Description
    q		string	the main search query
    fields		string	partially select output fields
    limit		string	amount of matches to return
    offset		string	offset for the list of matches
    operator		string	boolean operator to connect search phrases
    facet_field		string	faceting on fields. possible values: keyword, author, series, department, product or any combination
    facet_date		string	faceting on dates. possible values: 1day, 7day, 1month, 1year, 10year or any numerical variation
    sort		string	sort search results e.g. release_date desc

  • GETGet content by ID/content/:id
    Requesting a content object by its ID will get you an extensive resultset featuring the full article text and all available meta data. Partial field selection is available, if not all fields are of interest.
    
    

    Parameter	Value	Type	Description
    id		string	ID of the content object
    fields		string	partially select output fields

• Department

  • List Methods
  • Expand Methods

  • GETSearch all departments/department
    Departments correlate to the sections of our homepage and to those of the printed issues. There are top level departments and sub-departments. Both are accessible via this endpoint. Sub-departments have a link to their parent attached to them. The query expects an astisk for wildcards and whitespaces.
    
    

    Parameter	Value	Type	Description
    q		string	the main search query
    fields		string	partially select output fields
    limit		string	amount of matches to return
    offset		string	offset for the list of matches

  • GETGet department (articles) by ID/department/:id
    This endpoint provides a pre-filtered search for all articles belonging to a specific department. Deeper queries, pagination and partial field selection can be used to narrow down the match list.
    
    

    Parameter	Value	Type	Description
    id		string	ID of the department
    q		string	the main search query
    fields		string	partially select output fields
    limit		string	amount of matches to return
    offset		string	offset for the list of matches
    operator		string	boolean operator to connect search phrases

• Keyword

  • List Methods
  • Expand Methods

  • GETSearch all keywords/keyword
    This endpoint lets you search for keywords that semantically summarize articles. An asterisk can serve as a wildcard or whitespace in your search query. Keywords are weighted by their overall frequency with a score from 0 to 100. Possible keyword types are: location, person, organisation or issue.
    
    

    Parameter	Value	Type	Description
    q		string	the main search query
    fields		string	partially select output fields
    limit		string	amount of matches to return
    offset		string	offset for the list of matches

  • GETGet keyword (articles) by ID/keyword/:id
    This endpoint provides a pre-filtered search for all articles tagged with a specific keyword. Deeper queries, pagination and partial field selection can be used to narrow down the match list.
    
    

    Parameter	Value	Type	Description
    id		string	ID of the keyword
    q		string	the main search query
    fields		string	partially select output fields
    limit		string	amount of matches to return
    offset		string	offset for the list of matches
    operator		string	boolean operator to connect search phrases

• Product

  • List Methods
  • Expand Methods

  • GETSearch all products/product
    This endpoint lets you search for publication products by name. The product field of an article provides information about where the article was first published. An asterisk can serve as a wildcard or whitespace in your search query.
    
    

    Parameter	Value	Type	Description
    q		string	the main search query
    fields		string	partially select output fields
    limit		string	amount of matches to return
    offset		string	offset for the list of matches

  • GETGet product (articles) by ID/product/:id
    This endpoint provides a pre-filtered search for all articles published in a specific product. Deeper queries, pagination and partial field selection can be used to narrow down the match list.
    
    

    Parameter	Value	Type	Description
    id		string	ID of the product
    q		string	the main search query
    fields		string	partially select output fields
    limit		string	amount of matches to return
    offset		string	offset for the list of matches
    operator		string	boolean operator to connect search phrases

• Series

  • List Methods
  • Expand Methods

  • GETSearch all series/series
    This endpoint lets you search for journalistic series by name. An asterisk can serve as a wildcard or whitespace in your search query.
    
    

    Parameter	Value	Type	Description
    q		string	the main search query
    fields		string	partially select output fields
    limit		string	amount of matches to return
    offset		string	offset for the list of matches

  • GETGet series (articles) by ID/series/:id
    This endpoint provides a pre-filtered search for all articles written for a specific series. Deeper queries, pagination and partial field selection can be used to narrow down the match list.
    
    

    Parameter	Value	Type	Description
    id		string	ID of the series
    q		string	the main search query
    fields		string	partially select output fields
    limit		string	amount of matches to return
    offset		string	offset for the list of matches
    operator		string	boolean operator to connect search phrases