symbol

Finds occurrences of an identifier by name in a file

Given a file path and identifier name, returns:

Without position: All matching identifiers in the file
With position: The exact identifier with that name at that position, or 3 closest identifiers with that name

Example finding all occurrences of “user_name”:

let user_name = "John";  // First occurrence
println!("{}", user_name); // Second occurrence

When a position is provided, it searches for an exact match at that location. If no exact match exists, returns the 3 identifiers closest to the position based on line and character distance, prioritizing lines.

POST

symbol

find-identifier

curl --request POST \
  --url http://localhost:4444/v1/symbol/find-identifier \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "User",
  "path": "src/main.py",
  "position": null
}'

{
  "identifiers": [
    {
      "file_range": {
        "path": "src/main.py",
        "range": {
          "end": {
            "character": 5,
            "line": 10
          },
          "start": {
            "character": 5,
            "line": 10
          }
        }
      },
      "kind": "<string>",
      "name": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name

string

required

The name of the identifier to search for.

Example:

"User"

path

string

required

The path to the file to search for identifiers.

Example:

"src/main.py"

position

object | null

The position hint to search for identifiers. If not provided.

Response

200

application/json

Identifier retrieved successfully

identifiers

object[]

required

Get the definition of a symbol at a specific position in a file Find all symbols that are referenced from a given symbol's definition

curl --request POST \
  --url http://localhost:4444/v1/symbol/find-identifier \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "User",
  "path": "src/main.py",
  "position": null
}'

{
  "identifiers": [
    {
      "file_range": {
        "path": "src/main.py",
        "range": {
          "end": {
            "character": 5,
            "line": 10
          },
          "start": {
            "character": 5,
            "line": 10
          }
        }
      },
      "kind": "<string>",
      "name": "<string>"
    }
  ]
}

symbol

system

workspace

Finds occurrences of an identifier by name in a file

Authorizations

Body

Response