Papertrack Public Search API

GET /papertrack/api/v0.1/search

Papertracksearchapihandler.Get

Gets a list of papers

Query Parameters:

• mission ({'string', 'null'}) – The mission to search for (e.g. JWST, HST).

• count (integer) – Number of results per page (default 10).

• paper_type ({'array', 'null'}) – Paper types to search, e.g. SCIENCE, MENTION, DATA_INFLUENCED, SUPERMENTION

• instrument ({'array', 'null'}) – mission-specific instruments to search for. E.g. ACS, COS.

• included_date_start ({'string', 'null'}) – Search papers included in the bibliography on or after the specified date. Allowed formats are ‘%Y-%m-%d %H:%M:%S.%f’, ‘%Y-%m-%d %H:%M:%S’, and ‘%Y-%m-%d’.

• included_date_end ({'string', 'null'}) – Search papers included in the bibliography on or before the specified date. Allowed formats are ‘%Y-%m-%d %H:%M:%S.%f’, ‘%Y-%m-%d %H:%M:%S’, and ‘%Y-%m-%d’.

• publication_date_start ({'string', 'null'}) – Search papers published on or after the specified date. Allowed formats are ‘%Y-%m-%d %H:%M:%S.%f’, ‘%Y-%m-%d %H:%M:%S’, and ‘%Y-%m-%d’.

• publication_date_end ({'string', 'null'}) – Search papers published in the bibliography on or before the specified date. Allowed formats are ‘%Y-%m-%d %H:%M:%S.%f’, ‘%Y-%m-%d %H:%M:%S’, and ‘%Y-%m-%d’.

• updated_date_start ({'string', 'null'}) – Search papers updated in the bibliography on or after the specified date. Allowed formats are ‘%Y-%m-%d %H:%M:%S.%f’, ‘%Y-%m-%d %H:%M:%S’, and ‘%Y-%m-%d’.

• updated_date_end ({'string', 'null'}) – Search papers updated in the bibliography on or after the specified date. Allowed formats are ‘%Y-%m-%d %H:%M:%S.%f’, ‘%Y-%m-%d %H:%M:%S’, and ‘%Y-%m-%d’.

• authors ({'string', 'null'}) – Semi-colon-separated list of author names to search for. Each author name should be formatted in LastName, FirstName format. Partial names can be searched. E.g. ‘authors=Smith, J’, ‘authors=Smith;Jones’.

• title ({'array', 'null'}) – Title keywords/phrases to search for

• program ({'array', 'null'}) – HST or JWST program IDs

• bibcode ({'array', 'null'}) – ADS bibcode identifiers, e.g. 2006ApJS..167..161K. Use % as a wild card, e.g. ‘%ApJS%167%’.

• archival_flag ({'string', 'null'}) – Archival flags. Allowed values: GO,AR,Part,Unassigned or Any for all.

• refereed (string) – True to search refereed, False to search unrefereed, any to search all

• paper_state (string) – Set to all to search everything ‘published’ to search only published papers, ‘preprint’ to search only preprints.

• sort (string) – Field to sort by

• sort_dir (string) – Sort direction, desc for descending, asc for ascending

Example request:

GET /papertrack/api/v0.1/search HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  Successful Response

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {}
  

• 422 Unprocessable Entity –

  Validation Error

  Example response:

  HTTP/1.1 422 Unprocessable Entity
  Content-Type: application/json
  
  {
      "detail": [
          {
              "loc": [
                  "string",
                  1
              ],
              "msg": "string",
              "type": "string"
          }
      ]
  }
  

POST /papertrack/api/v0.1/public-search

Publicsearchhandler.Post

Decodes JSON into parameters to search the papertrack database then returns JSON results

Example request:

POST /papertrack/api/v0.1/public-search HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "archival_flag": [
        "GO"
    ],
    "authors": "Bruch",
    "bibcodes": "%608B",
    "bibstems": "ApJ",
    "first_author": true,
    "format": "json",
    "hst_programs": "10152",
    "instruments": [
        "ACS"
    ],
    "jwst_programs": "",
    "mission": "HST",
    "page": 0,
    "pagesize": 10,
    "papertypes": [
        "SCIENCE"
    ],
    "publication_years": "2010",
    "titles": "Luminosity Galaxy Clusters"
}

Status Codes:

• 200 OK –

  Successful Response

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {
      "bibcode": "2010ApJ...724..608B",
      "citation_count": 3,
      "coauthors": [
          "Donahue, Megan",
          "Voit, G. Mark",
          "Sun, Ming",
          "Conselice, Christopher J."
      ],
      "first_author": "Bruch, Seth",
      "hst_archival_flag": "GO",
      "instruments": [
          "ACS"
      ],
      "journal": "The Astrophysical Journal (ApJ)",
      "missions": [
          "HST",
          "XMM"
      ],
      "papertypes": [
          "SCIENCE"
      ],
      "program_ids": [
          "10152"
      ],
      "publication_date": "2010-11-01T00:00:00",
      "title": "XMM-NEWTON Observations of Three Low X-ray Luminosity Galaxy Clusters"
  }
  

• 422 Unprocessable Entity –

  Validation Error

  Example response:

  HTTP/1.1 422 Unprocessable Entity
  Content-Type: application/json
  
  {
      "detail": [
          {
              "loc": [
                  "string",
                  1
              ],
              "msg": "string",
              "type": "string"
          }
      ]
  }
  

GET /papertrack/api/v0.1/proper_template/{mission_str}

Propertemplateshandler.Get

Get list of proper templates

Parameters:

• mission_str (string) –

Query Parameters:

• template_program (string) – (Required)

• template_instrument ({'string', 'null'}) –

Example request:

GET /papertrack/api/v0.1/proper_template/{mission_str}?template_program=string HTTP/1.1
Host: example.com

Status Codes:

• 200 OK –

  Successful Response

  Example response:

  HTTP/1.1 200 OK
  Content-Type: application/json
  
  {}
  

• 422 Unprocessable Entity –

  Validation Error

  Example response:

  HTTP/1.1 422 Unprocessable Entity
  Content-Type: application/json
  
  {
      "detail": [
          {
              "loc": [
                  "string",
                  1
              ],
              "msg": "string",
              "type": "string"
          }
      ]
  }