pub.chive.discovery.getCitations

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "citation": {
      "properties": {
        "citedUri": {
          "description": "AT-URI of the cited paper",
          "format": "at-uri",
          "type": "string"
        },
        "citingUri": {
          "description": "AT-URI of the citing paper",
          "format": "at-uri",
          "type": "string"
        },
        "discoveredAt": {
          "description": "When this citation was discovered",
          "format": "datetime",
          "type": "string"
        },
        "isInfluential": {
          "description": "Whether this is an influential citation",
          "type": "boolean"
        },
        "source": {
          "description": "Source of citation data (e.g., semantic-scholar, openalex)",
          "type": "string"
        }
      },
      "required": [
        "citingUri",
        "citedUri",
        "source"
      ],
      "type": "object"
    },
    "citationCounts": {
      "properties": {
        "citedByCount": {
          "description": "Number of papers citing this eprint",
          "minimum": 0,
          "type": "integer"
        },
        "influentialCitedByCount": {
          "description": "Number of influential citations",
          "minimum": 0,
          "type": "integer"
        },
        "referencesCount": {
          "description": "Number of papers this eprint references",
          "minimum": 0,
          "type": "integer"
        }
      },
      "required": [
        "citedByCount",
        "referencesCount",
        "influentialCitedByCount"
      ],
      "type": "object"
    },
    "eprintRef": {
      "description": "An eprint named well enough to identify it on sight. The citation graph stores only URIs on its nodes, so an edge read back from it carries nothing a reader could recognise.",
      "properties": {
        "authors": {
          "description": "Author names in record order. A citation is identified by who wrote it as much as by its title.",
          "items": {
            "maxLength": 256,
            "type": "string"
          },
          "type": "array"
        },
        "title": {
          "type": "string"
        },
        "uri": {
          "format": "at-uri",
          "type": "string"
        },
        "venue": {
          "description": "Journal or proceedings the eprint appeared in, when known.",
          "maxLength": 512,
          "type": "string"
        },
        "year": {
          "description": "Publication year, when the eprint records a published version.",
          "type": "integer"
        }
      },
      "required": [
        "uri",
        "title"
      ],
      "type": "object"
    },
    "main": {
      "description": "Get citation network data for an eprint, including papers that cite it and papers it references (within the Chive index)",
      "errors": [
        {
          "name": "NotFound"
        },
        {
          "name": "ServiceUnavailable"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "citations": {
              "items": {
                "ref": "#citation",
                "type": "ref"
              },
              "type": "array"
            },
            "counts": {
              "ref": "#citationCounts",
              "type": "ref"
            },
            "cursor": {
              "description": "Pagination cursor for next page",
              "type": "string"
            },
            "eprint": {
              "ref": "#eprintRef",
              "type": "ref"
            },
            "hasMore": {
              "description": "Whether more results are available",
              "type": "boolean"
            },
            "papers": {
              "description": "Every eprint appearing at either end of the returned citations, once each. A lookup rather than metadata repeated on each edge: a densely connected paper would otherwise carry the same author list dozens of times in one response.",
              "items": {
                "ref": "#eprintRef",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "eprint",
            "counts",
            "citations",
            "hasMore"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "cursor": {
            "description": "Pagination cursor",
            "type": "string"
          },
          "direction": {
            "default": "both",
            "description": "Citation direction: citing (papers this cites), cited-by (papers citing this), or both",
            "knownValues": [
              "citing",
              "cited-by",
              "both"
            ],
            "type": "string"
          },
          "limit": {
            "default": 20,
            "description": "Maximum number of citations to return",
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          },
          "onlyInfluential": {
            "default": false,
            "description": "Only return influential citations",
            "type": "boolean"
          },
          "uri": {
            "description": "AT-URI of the eprint",
            "format": "at-uri",
            "type": "string"
          }
        },
        "required": [
          "uri"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "pub.chive.discovery.getCitations",
  "lexicon": 1,
  "revision": 1
}