ar X iv Assistant

ar X iv Assistant · GPT 작업

arXiv Metadata API (Atom+XML)

A query API for arXiv paper metadata.

  • GET /queryquery

    Returns all published arXiv papers that respond to the specified query parameters. By default, returns most recent papers first.

원본 API 스키마
{
  "openapi": "3.0.0",
  "info": {
    "version": "0.1.2",
    "title": "arXiv Metadata API (Atom+XML)",
    "description": "A query API for arXiv paper metadata.\n",
    "termsOfService": "https://arxiv.org/help/general",
    "contact": {
      "name": "arXiv API Team",
      "email": "nextgen@arxiv.org"
    },
    "license": {
      "name": "MIT"
    }
  },
  "servers": [
    {
      "url": "https://export.arxiv.org/api/",
      "description": "Metadata API endpoint."
    }
  ],
  "paths": {
    "/query": {
      "get": {
        "operationId": "query",
        "description": "Returns all published arXiv papers that respond to the specified\nquery parameters. By default, returns most recent papers first.\n",
        "parameters": [
          {
            "name": "search_query",
            "in": "query",
            "description": "A string that represents a search query. Fields are specified by \"field:value\" and \ndelimited with \"AND\", \"OR\", and \"ANDNOT\" boolean operators. Valid field names are:\nti (title), au (author), abs(abstract), co (comment), jr (journal reference), cat\n(subject category), rn (report number), id (id - use id_list instead), all (all \nfields).\n",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "au:del_maestro+AND+ti:checkerboard"
          },
          {
            "name": "id_list",
            "in": "query",
            "description": "A comma-delimited list of arXiv id's.\n",
            "required": false,
            "schema": {
              "type": "string"
            },
            "example": "1234.12345,5678.56789"
          },
          {
            "name": "start",
            "in": "query",
            "description": "Defines the index of the first returned result, using 0-based indexing.\n",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "example": 0
          },
          {
            "name": "max_results",
            "in": "query",
            "description": "The number of results returned by the query. Used in conjunction with \"start\" for \npagination. Max_results is limited to 30000, in slices of 2000.\n",
            "required": false,
            "schema": {
              "type": "integer"
            },
            "example": 10
          },
          {
            "name": "sortBy",
            "in": "query",
            "description": "Method to sort results.\n",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "relevance",
                "lastUpdatedDate",
                "submittedDate"
              ]
            }
          },
          {
            "name": "sortOrder",
            "in": "query",
            "description": "Order for the sort method\n",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "ascending",
                "descending"
              ]
            }
          }
        ],
        "responses": {
          "default": {
            "description": "All queries return a valid Atom XML feed, even errors.",
            "content": {
              "application/atom+xml": {
                "schema": {
                  "$ref": "./resources/AtomXML.yaml#"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Error": {
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}