# pub.chive.actor.discoverAuthorIds

> 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.actor.discoverAuthorIds)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.actor.discoverAuthorIds/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.actor.discoverAuthorIds/examples)

## Definitions

### `pub.chive.actor.discoverAuthorIds`

**Type**: `query`

Discover external author IDs (OpenAlex, Semantic Scholar, etc.) by searching for a name across academic databases

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `name` | `string` | No | Author name to search for |
| `limit` | `integer` | No | Maximum number of matches to return |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `matches` | `array` | Yes |  |
| `searchedName` | `string` | Yes | The name that was searched |

#### Errors

- **AuthenticationRequired**

### `pub.chive.actor.discoverAuthorIds#authorMatch`

**Type**: `object`

A potential author match from academic databases

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `ids` | `ref` → `#externalIds` | Yes |  |
| `worksCount` | `integer` | Yes | Number of works attributed to this author |
| `displayName` | `string` | Yes | Display name from the database |
| `institution` | `string` | No | Current institutional affiliation |
| `citedByCount` | `integer` | Yes | Total citation count |

### `pub.chive.actor.discoverAuthorIds#externalIds`

**Type**: `object`

External author identifiers from various databases

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `dblp` | `string` | No | DBLP author identifier |
| `orcid` | `string` | No | ORCID identifier |
| `openalex` | `string` | No | OpenAlex author ID (e.g., A5023888391) |
| `semanticScholar` | `string` | No | Semantic Scholar author ID |

## Raw Schema

```json
{
  "id": "pub.chive.actor.discoverAuthorIds",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "AuthenticationRequired"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "searchedName",
            "matches"
          ],
          "properties": {
            "matches": {
              "type": "array",
              "items": {
                "ref": "#authorMatch",
                "type": "ref"
              }
            },
            "searchedName": {
              "type": "string",
              "description": "The name that was searched"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "description": "Author name to search for"
          },
          "limit": {
            "type": "integer",
            "default": 5,
            "maximum": 20,
            "minimum": 1,
            "description": "Maximum number of matches to return"
          }
        }
      },
      "description": "Discover external author IDs (OpenAlex, Semantic Scholar, etc.) by searching for a name across academic databases"
    },
    "authorMatch": {
      "type": "object",
      "required": [
        "displayName",
        "worksCount",
        "citedByCount",
        "ids"
      ],
      "properties": {
        "ids": {
          "ref": "#externalIds",
          "type": "ref"
        },
        "worksCount": {
          "type": "integer",
          "minimum": 0,
          "description": "Number of works attributed to this author"
        },
        "displayName": {
          "type": "string",
          "description": "Display name from the database"
        },
        "institution": {
          "type": "string",
          "description": "Current institutional affiliation"
        },
        "citedByCount": {
          "type": "integer",
          "minimum": 0,
          "description": "Total citation count"
        }
      },
      "description": "A potential author match from academic databases"
    },
    "externalIds": {
      "type": "object",
      "properties": {
        "dblp": {
          "type": "string",
          "description": "DBLP author identifier"
        },
        "orcid": {
          "type": "string",
          "description": "ORCID identifier"
        },
        "openalex": {
          "type": "string",
          "description": "OpenAlex author ID (e.g., A5023888391)"
        },
        "semanticScholar": {
          "type": "string",
          "description": "Semantic Scholar author ID"
        }
      },
      "description": "External author identifiers from various databases"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1
}
```
