# pub.chive.author.getProfile

> Published by [chive.pub](https://lexicon.garden/identity/did:plc:7natp5xae72bddaqlkef2t4e)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.author.getProfile)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.author.getProfile/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.author.getProfile/examples)

## Definitions

### `pub.chive.author.getProfile`

**Type**: `query`

Get author profile and metrics by DID

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes | Author DID |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `metrics` | `ref` → `#authorMetrics` | Yes |  |
| `profile` | `ref` → `#authorProfile` | Yes |  |

#### Errors

- **NotFound**

### `pub.chive.author.getProfile#authorMetrics`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `totalViews` | `integer` | Yes |  |
| `totalEprints` | `integer` | Yes |  |
| `totalDownloads` | `integer` | Yes |  |
| `totalEndorsements` | `integer` | Yes |  |

### `pub.chive.author.getProfile#authorProfile`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `bio` | `string` | No |  |
| `did` | `string` (did) | Yes |  |
| `orcid` | `string` | No |  |
| `avatar` | `string` (uri) | No |  |
| `dblpId` | `string` | No |  |
| `fields` | `array` | No |  |
| `handle` | `string` | No |  |
| `website` | `string` (uri) | No |  |
| `openAlexId` | `string` | No |  |
| `affiliation` | `string` | No |  |
| `displayName` | `string` | No |  |
| `pdsEndpoint` | `string` | No |  |
| `affiliations` | `array` | No |  |
| `nameVariants` | `array` | No |  |
| `openReviewId` | `string` | No |  |
| `arxivAuthorId` | `string` | No |  |
| `orcidVerified` | `boolean` | No | Whether the author's ORCID has been verified via OAuth |
| `scopusAuthorId` | `string` | No |  |
| `googleScholarId` | `string` | No |  |
| `researchKeywords` | `array` | No |  |
| `semanticScholarId` | `string` | No |  |
| `previousAffiliations` | `array` | No |  |

### `pub.chive.author.getProfile#researchKeyword`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `label` | `string` | Yes |  |
| `fastId` | `string` | No |  |
| `wikidataId` | `string` | No |  |

## Raw Schema

```json
{
  "id": "pub.chive.author.getProfile",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "NotFound"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "profile",
            "metrics"
          ],
          "properties": {
            "metrics": {
              "ref": "#authorMetrics",
              "type": "ref"
            },
            "profile": {
              "ref": "#authorProfile",
              "type": "ref"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "did"
        ],
        "properties": {
          "did": {
            "type": "string",
            "format": "did",
            "description": "Author DID"
          }
        }
      },
      "description": "Get author profile and metrics by DID"
    },
    "authorMetrics": {
      "type": "object",
      "required": [
        "totalEprints",
        "totalViews",
        "totalDownloads",
        "totalEndorsements"
      ],
      "properties": {
        "totalViews": {
          "type": "integer"
        },
        "totalEprints": {
          "type": "integer"
        },
        "totalDownloads": {
          "type": "integer"
        },
        "totalEndorsements": {
          "type": "integer"
        }
      }
    },
    "authorProfile": {
      "type": "object",
      "required": [
        "did"
      ],
      "properties": {
        "bio": {
          "type": "string"
        },
        "did": {
          "type": "string",
          "format": "did"
        },
        "orcid": {
          "type": "string"
        },
        "avatar": {
          "type": "string",
          "format": "uri"
        },
        "dblpId": {
          "type": "string"
        },
        "fields": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "handle": {
          "type": "string"
        },
        "website": {
          "type": "string",
          "format": "uri"
        },
        "openAlexId": {
          "type": "string"
        },
        "affiliation": {
          "type": "string"
        },
        "displayName": {
          "type": "string"
        },
        "pdsEndpoint": {
          "type": "string"
        },
        "affiliations": {
          "type": "array",
          "items": {
            "ref": "pub.chive.defs#affiliation",
            "type": "ref"
          }
        },
        "nameVariants": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "openReviewId": {
          "type": "string"
        },
        "arxivAuthorId": {
          "type": "string"
        },
        "orcidVerified": {
          "type": "boolean",
          "description": "Whether the author's ORCID has been verified via OAuth"
        },
        "scopusAuthorId": {
          "type": "string"
        },
        "googleScholarId": {
          "type": "string"
        },
        "researchKeywords": {
          "type": "array",
          "items": {
            "ref": "#researchKeyword",
            "type": "ref"
          }
        },
        "semanticScholarId": {
          "type": "string"
        },
        "previousAffiliations": {
          "type": "array",
          "items": {
            "ref": "pub.chive.defs#affiliation",
            "type": "ref"
          }
        }
      }
    },
    "researchKeyword": {
      "type": "object",
      "required": [
        "label"
      ],
      "properties": {
        "label": {
          "type": "string"
        },
        "fastId": {
          "type": "string"
        },
        "wikidataId": {
          "type": "string"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 3
}
```