pub.chive.claiming.findClaimable

chive.pub

Documentation

Find claimable eprints matching the user's identity or search criteria. Requires authentication.

main query

Find claimable eprints matching the user's identity or search criteria. Requires authentication.

Parameters

cursor string Optional

Pagination cursor for next page

limit integer Optional

Maximum number of results to return

q string Optional

Search query (title, author name, DOI)

source string Optional

Filter by external source

Output

Encodingapplication/json
cursor string Optional

Cursor for next page of results

eprints array Required

List of claimable eprints

hasMore boolean Required

Whether more results are available

Errors

AuthenticationRequired Authentication is required to find claimable eprints
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Pagination cursor for next page
Maximum number of results to return
Search query (title, author name, DOI)
Filter by external source
View raw schema
{
  "type": "query",
  "errors": [
    {
      "name": "AuthenticationRequired",
      "description": "Authentication is required to find claimable eprints"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "eprints",
        "hasMore"
      ],
      "properties": {
        "cursor": {
          "type": "string",
          "description": "Cursor for next page of results"
        },
        "eprints": {
          "type": "array",
          "items": {
            "ref": "#claimableEprint",
            "type": "ref"
          },
          "description": "List of claimable eprints"
        },
        "hasMore": {
          "type": "boolean",
          "description": "Whether more results are available"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "properties": {
      "q": {
        "type": "string",
        "description": "Search query (title, author name, DOI)"
      },
      "limit": {
        "type": "integer",
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "description": "Maximum number of results to return"
      },
      "cursor": {
        "type": "string",
        "description": "Pagination cursor for next page"
      },
      "source": {
        "type": "string",
        "description": "Filter by external source",
        "knownValues": [
          "arxiv",
          "biorxiv",
          "medrxiv",
          "osf",
          "lingbuzz",
          "zenodo",
          "ssrn",
          "philpapers"
        ]
      }
    }
  },
  "description": "Find claimable eprints matching the user's identity or search criteria. Requires authentication."
}
claimableEprint object

An eprint that can be claimed by the user

Properties

doi string Optional

DOI if assigned

externalId string Required

Source-specific identifier

id integer Required

Internal import ID

publicationDate string datetime Optional

Publication or submission date

source string Required

External source identifier

title string Required

Eprint title

url string uri Required

URL to the eprint on the external source

View raw schema
{
  "type": "object",
  "required": [
    "id",
    "source",
    "externalId",
    "url",
    "title",
    "authors"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "description": "Internal import ID"
    },
    "doi": {
      "type": "string",
      "description": "DOI if assigned"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "URL to the eprint on the external source"
    },
    "title": {
      "type": "string",
      "description": "Eprint title"
    },
    "source": {
      "type": "string",
      "description": "External source identifier"
    },
    "authors": {
      "type": "array",
      "items": {
        "ref": "#eprintAuthor",
        "type": "ref"
      },
      "description": "List of authors"
    },
    "externalId": {
      "type": "string",
      "description": "Source-specific identifier"
    },
    "publicationDate": {
      "type": "string",
      "format": "datetime",
      "description": "Publication or submission date"
    }
  },
  "description": "An eprint that can be claimed by the user"
}
eprintAuthor object

Author information from external source

Properties

affiliation string Optional

Institutional affiliation if available

name string Required

Author display name

orcid string Optional

ORCID identifier if available

View raw schema
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Author display name"
    },
    "orcid": {
      "type": "string",
      "description": "ORCID identifier if available"
    },
    "affiliation": {
      "type": "string",
      "description": "Institutional affiliation if available"
    }
  },
  "description": "Author information from external source"
}

Lexicon Garden

@