swagger: '2.0'
info:
  version: 2.0.0
  title: Archive Content API
  description: 'The Archive API returns an array of NYT articles for a given month, going back to 1851.  Its response fields are the same as the Article Search API. The Archive API is very useful if you want to build your own database of NYT article metadata. You simply pass the API the year and month and it returns a JSON object with all articles for that month.  The response size can be large (~20mb).


    ```

    /{year}/{month}.json

    ```


    ## Example Call

    ```

    https://api.nytimes.com/svc/archive/v1/2019/1.json?api-key=yourkey

    ```

    '
host: api.nytimes.com
basePath: /svc/archive/v1
schemes:
- https
produces:
- application/json
security:
- apikey: []
tags:
- name: Content
paths:
  /content/{source}/{section}.json:
    get:
      parameters:
      - name: source
        in: path
        description: 'Limits the set of items by originating source


          all = items from both The New York Times and The International New York Times

          nyt = New York Times items only

          iht = International New York Times (FKA International Herald Tribune) items only

          '
        type: string
        enum:
        - all
        - nyt
        - iht
        required: true
        x-consoleDefault: all
      - name: section
        in: path
        description: "Limits the set of items by one or more sections\nall | One or more section names, separated by semicolons\n\n To get all sections, specify all. To get a particular section or sections, use the section names returned by this request:\n http://api.nytimes.com/svc/news/v3/content/section-list.json\n"
        default: all
        required: true
        type: string
        x-consoleDefault: all
      - name: limit
        in: query
        description: Limits the number of results, between 1 and 20
        default: 20
        required: false
        type: integer
      - name: offset
        in: query
        description: Sets the starting point of the result set
        required: false
        default: 0
        type: integer
      responses:
        '200':
          description: An array of Articles
          schema:
            type: object
            properties:
              status:
                type: string
              copyright:
                type: string
              num_results:
                type: integer
              results:
                type: array
                items:
                  $ref: '#/definitions/Article'
        '401':
          description: Unauthorized request.  Make sure api-key is set.
        '429':
          description: Too many requests.  You reached your per minute or per day rate limit.
      tags:
      - Content
  /content/{source}/{section}/{time-period}.json:
    get:
      parameters:
      - name: source
        in: path
        description: 'Limits the set of items by originating source


          all = items from both The New York Times and The International New York Times

          nyt = New York Times items only

          iht = International New York Times items only

          '
        type: string
        enum:
        - all
        - nyt
        - iht
        default: all
        required: true
      - name: section
        in: path
        description: "Limits the set of items by one or more sections\nall | One or more section names, separated by semicolons\n\n To get all sections, specify all. To get a particular section or sections, use the section names returned by this request:\n http://api.nytimes.com/svc/news/v3/content/section-list.json\n"
        default: all
        required: true
        type: string
      - name: time-period
        in: path
        description: Limits the set of items by time published, integer in number of hours
        type: integer
        default: 12
        required: true
      - name: limit
        in: query
        description: Limits the number of results, between 1 and 20
        default: 20
        required: false
        type: integer
      - name: offset
        in: query
        description: Sets the starting point of the result set
        required: false
        default: 0
        type: integer
      responses:
        '200':
          description: An array of Articles
          schema:
            type: object
            properties:
              status:
                type: string
              copyright:
                type: string
              num_results:
                type: integer
              results:
                type: array
                items:
                  $ref: '#/definitions/Article'
        '401':
          description: Unauthorized request.  Make sure api-key is set.
        '429':
          description: Too many requests.  You reached your per minute or per day rate limit.
      tags:
      - Content
definitions:
  Article:
    type: object
    properties:
      section:
        type: string
      subsection:
        type: string
      title:
        type: string
      abstract:
        type: string
      url:
        type: string
      short_url:
        type: string
      byline:
        type: string
      thumbnail_standard:
        type: string
      item_type:
        type: string
      source:
        type: string
      updated_date:
        type: string
      created_date:
        type: string
      published_date:
        type: string
      material_type_facet:
        type: string
      kicker:
        type: string
      headline:
        type: string
      des_facet:
        type: array
        items:
          type: string
      org_facet:
        type: string
      per_facet:
        type: array
        items:
          type: string
      geo_facet:
        type: array
        items:
          type: string
      blog_name:
        type: string
      related_urls:
        type: array
        items:
          type: object
          properties:
            suggested_link_text:
              type: string
            url:
              type: string
      multimedia:
        type: array
        items:
          type: object
          properties:
            url:
              type: string
            format:
              type: string
            height:
              type: integer
            width:
              type: integer
            type:
              type: string
            subtype:
              type: string
            caption:
              type: string
            copyright:
              type: string
securityDefinitions:
  apikey:
    type: apiKey
    name: api-key
    in: query