pub.chive.author.getProfile

lexicons.governance.chive.pub

Documentation

Get author profile and metrics by DID

main query

Get author profile and metrics by DID

Parameters

did string did Required

Author DID

Output

Encodingapplication/json

Errors

NotFound
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
Author DID
View raw schema 
{
  "description": "Get author profile and metrics by DID",
  "errors": [
    {
      "name": "NotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "metrics": {
          "ref": "#authorMetrics",
          "type": "ref"
        },
        "profile": {
          "ref": "#authorProfile",
          "type": "ref"
        },
        "sifa": {
          "ref": "#sifaProfile",
          "type": "ref"
        }
      },
      "required": [
        "profile",
        "metrics"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "did": {
        "description": "Author DID",
        "format": "did",
        "type": "string"
      }
    },
    "required": [
      "did"
    ],
    "type": "params"
  },
  "type": "query"
}
authorMetrics object

No description available.

Properties

totalDownloads integer Required

No description available.

totalEndorsements integer Required

No description available.

totalEprints integer Required

No description available.

totalViews integer Required

No description available.

View raw schema 
{
  "properties": {
    "totalDownloads": {
      "type": "integer"
    },
    "totalEndorsements": {
      "type": "integer"
    },
    "totalEprints": {
      "type": "integer"
    },
    "totalViews": {
      "type": "integer"
    }
  },
  "required": [
    "totalEprints",
    "totalViews",
    "totalDownloads",
    "totalEndorsements"
  ],
  "type": "object"
}
authorProfile object

No description available.

Properties

affiliation string Optional

No description available.

arxivAuthorId string Optional

No description available.

avatar string uri Optional

A valid URI.

bio string Optional

No description available.

bioRich array of union Optional

Rich bio, the same item union reviews and abstracts use. `bio` holds its plain text.

Known types:
dblpId string Optional

No description available.

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

fields array of string Optional

No description available.

googleScholarId string Optional

No description available.

handle string Optional

No description available.

nameVariants array of string Optional

No description available.

openAlexId string Optional

No description available.

openReviewId string Optional

No description available.

orcid string Optional

No description available.

orcidVerified boolean Optional

Whether the author's ORCID has been verified via OAuth

pdsEndpoint string Optional

No description available.

researchKeywords array of ref#researchKeyword Optional

No description available.

scopusAuthorId string Optional

No description available.

semanticScholarId string Optional

No description available.

website string uri Optional

A valid URI.

View raw schema 
{
  "properties": {
    "affiliation": {
      "type": "string"
    },
    "affiliations": {
      "items": {
        "ref": "pub.chive.defs#affiliation",
        "type": "ref"
      },
      "type": "array"
    },
    "arxivAuthorId": {
      "type": "string"
    },
    "avatar": {
      "format": "uri",
      "type": "string"
    },
    "bio": {
      "type": "string"
    },
    "bioRich": {
      "description": "Rich bio, the same item union reviews and abstracts use. `bio` holds its plain text.",
      "items": {
        "refs": [
          "pub.chive.richtext.defs#textItem",
          "pub.chive.richtext.defs#nodeRefItem",
          "pub.chive.richtext.defs#wikidataRefItem",
          "pub.chive.richtext.defs#fieldRefItem",
          "pub.chive.richtext.defs#facetRefItem",
          "pub.chive.richtext.defs#eprintRefItem",
          "pub.chive.richtext.defs#annotationRefItem",
          "pub.chive.richtext.defs#authorRefItem",
          "pub.chive.richtext.defs#mentionItem",
          "pub.chive.richtext.defs#linkItem",
          "pub.chive.richtext.defs#tagItem",
          "pub.chive.richtext.defs#latexItem",
          "pub.chive.richtext.defs#codeBlockItem",
          "pub.chive.richtext.defs#headingItem",
          "pub.chive.richtext.defs#listItem",
          "pub.chive.richtext.defs#blockquoteItem"
        ],
        "type": "union"
      },
      "type": "array"
    },
    "dblpId": {
      "type": "string"
    },
    "did": {
      "format": "did",
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "fields": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "googleScholarId": {
      "type": "string"
    },
    "handle": {
      "type": "string"
    },
    "nameVariants": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "openAlexId": {
      "type": "string"
    },
    "openReviewId": {
      "type": "string"
    },
    "orcid": {
      "type": "string"
    },
    "orcidVerified": {
      "description": "Whether the author's ORCID has been verified via OAuth",
      "type": "boolean"
    },
    "pdsEndpoint": {
      "type": "string"
    },
    "previousAffiliations": {
      "items": {
        "ref": "pub.chive.defs#affiliation",
        "type": "ref"
      },
      "type": "array"
    },
    "researchKeywords": {
      "items": {
        "ref": "#researchKeyword",
        "type": "ref"
      },
      "type": "array"
    },
    "scopusAuthorId": {
      "type": "string"
    },
    "semanticScholarId": {
      "type": "string"
    },
    "website": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "did"
  ],
  "type": "object"
}
researchKeyword object

No description available.

Properties

fastId string Optional

No description available.

label string Required

No description available.

wikidataId string Optional

No description available.

View raw schema 
{
  "properties": {
    "fastId": {
      "type": "string"
    },
    "label": {
      "type": "string"
    },
    "wikidataId": {
      "type": "string"
    }
  },
  "required": [
    "label"
  ],
  "type": "object"
}
sifaProfile object

A researcher's sifa.id profile, read from their own repository. Chive never writes these records; they belong to the researcher.

Properties

about string Optional

No description available.

currentRoles array of ref#sifaRole Optional

No description available.

displayName string Optional

No description available.

hasProfile boolean Required

Whether the researcher has any sifa records.

headline string Optional

One-line description of what the researcher does.

previousRoles array of ref#sifaRole Optional

No description available.

pronouns string Optional

No description available.

View raw schema 
{
  "description": "A researcher's sifa.id profile, read from their own repository. Chive never writes these records; they belong to the researcher.",
  "properties": {
    "about": {
      "type": "string"
    },
    "currentRoles": {
      "items": {
        "ref": "#sifaRole",
        "type": "ref"
      },
      "type": "array"
    },
    "displayName": {
      "type": "string"
    },
    "hasProfile": {
      "description": "Whether the researcher has any sifa records.",
      "type": "boolean"
    },
    "headline": {
      "description": "One-line description of what the researcher does.",
      "type": "string"
    },
    "previousRoles": {
      "items": {
        "ref": "#sifaRole",
        "type": "ref"
      },
      "type": "array"
    },
    "pronouns": {
      "type": "string"
    }
  },
  "required": [
    "hasProfile"
  ],
  "type": "object"
}
sifaRole object

A role held at an institution, read from the researcher's own id.sifa.* records.

Properties

endedAt string Optional

ISO date the role ended. Absent means current.

institution string Required

Institution or employer name.

institutionDid string did Optional

The institution's own DID, when sifa records one.

isPrimary boolean Optional

Whether sifa marks this the primary position.

source string Required

Which sifa collection this came from.

Known values: position, education
startedAt string Optional

ISO date the role began.

title string Optional

Job title, or degree and field for education.

View raw schema 
{
  "description": "A role held at an institution, read from the researcher's own id.sifa.* records.",
  "properties": {
    "endedAt": {
      "description": "ISO date the role ended. Absent means current.",
      "type": "string"
    },
    "institution": {
      "description": "Institution or employer name.",
      "type": "string"
    },
    "institutionDid": {
      "description": "The institution's own DID, when sifa records one.",
      "format": "did",
      "type": "string"
    },
    "isPrimary": {
      "description": "Whether sifa marks this the primary position.",
      "type": "boolean"
    },
    "source": {
      "description": "Which sifa collection this came from.",
      "knownValues": [
        "position",
        "education"
      ],
      "type": "string"
    },
    "startedAt": {
      "description": "ISO date the role began.",
      "type": "string"
    },
    "title": {
      "description": "Job title, or degree and field for education.",
      "type": "string"
    }
  },
  "required": [
    "institution",
    "source"
  ],
  "type": "object"
}

Lexicon Garden

@