# app.rocksky.song.matchSong

> Published by [rocksky.app](https://lexicon.garden/identity/did:plc:vegqomyce4ssoqs7zwqvgqty)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:vegqomyce4ssoqs7zwqvgqty/app.rocksky.song.matchSong)
- [Documentation](https://lexicon.garden/lexicon/did:plc:vegqomyce4ssoqs7zwqvgqty/app.rocksky.song.matchSong/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:vegqomyce4ssoqs7zwqvgqty/app.rocksky.song.matchSong/examples)

## Definitions

### `app.rocksky.song.matchSong`

**Type**: `query`

Matches a song against Rocksky’s music database and external metadata providers to resolve the best canonical track, artist, and album

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `isrc` | `string` | No | Optional International Standard Recording Code (ISRC) to anchor the match |
| `mbId` | `string` | No | Optional MusicBrainz recording ID to anchor the match |
| `title` | `string` | Yes | The title of the song to retrieve |
| `artist` | `string` | Yes | The artist of the song to retrieve |

#### Output

**Encoding**: `application/json`

## Raw Schema

```json
{
  "id": "app.rocksky.song.matchSong",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "ref": "app.rocksky.song.defs#songViewDetailed",
          "type": "ref"
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "title",
          "artist"
        ],
        "properties": {
          "isrc": {
            "type": "string",
            "description": "Optional International Standard Recording Code (ISRC) to anchor the match"
          },
          "mbId": {
            "type": "string",
            "description": "Optional MusicBrainz recording ID to anchor the match"
          },
          "title": {
            "type": "string",
            "description": "The title of the song to retrieve"
          },
          "artist": {
            "type": "string",
            "description": "The artist of the song to retrieve"
          }
        }
      },
      "description": "Matches a song against Rocksky’s music database and external metadata providers to resolve the best canonical track, artist, and album"
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```