Find all symbols that are referenced from a given symbol's definition

curl --request POST \
  --url http://localhost:4444/v1/symbol/find-referenced-symbols \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier_position": {
    "path": "src/main.py",
    "position": {
      "character": 5,
      "line": 10
    }
  },
  "full_scan": false
}
'

{
  "external_symbols": [
    {
      "file_range": {
        "path": "src/main.py",
        "range": {
          "end": {
            "character": 5,
            "line": 10
          },
          "start": {
            "character": 5,
            "line": 10
          }
        }
      },
      "name": "<string>",
      "kind": "<string>"
    }
  ],
  "not_found": [
    {
      "file_range": {
        "path": "src/main.py",
        "range": {
          "end": {
            "character": 5,
            "line": 10
          },
          "start": {
            "character": 5,
            "line": 10
          }
        }
      },
      "name": "<string>",
      "kind": "<string>"
    }
  ],
  "workspace_symbols": [
    {
      "definitions": [
        {
          "file_range": {
            "path": "src/main.py",
            "range": {
              "end": {
                "character": 5,
                "line": 10
              },
              "start": {
                "character": 5,
                "line": 10
              }
            }
          },
          "identifier_position": {
            "path": "src/main.py",
            "position": {
              "character": 5,
              "line": 10
            }
          },
          "kind": "class",
          "name": "User"
        }
      ],
      "reference": {
        "file_range": {
          "path": "src/main.py",
          "range": {
            "end": {
              "character": 5,
              "line": 10
            },
            "start": {
              "character": 5,
              "line": 10
            }
          }
        },
        "name": "<string>",
        "kind": "<string>"
      }
    }
  ]
}

symbol

Find all symbols that are referenced from a given symbol's definition

The input position must point to a symbol (e.g. function name, class name, variable name). Returns all symbols referenced within that symbol’s implementation, categorized into:

Workspace symbols (with their definitions)
External symbols (built-in functions like ‘len’, ‘print’ or from external libraries)
Symbols that couldn’t be found

e.g. for a function definition in main.py:

@log_execution_time     # Reference to decorator
def process_user():     # <-- Input position here
    user = User()       # Reference to User class
    print("Done")       # Reference to built-in function

This would return:

Workspace symbols: [ log_execution_time (with definition from decorators.py), User (with definition from models.py) ]
External symbols: print (Python built-in)

POST

symbol

find-referenced-symbols

Find all symbols that are referenced from a given symbol's definition

curl --request POST \
  --url http://localhost:4444/v1/symbol/find-referenced-symbols \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier_position": {
    "path": "src/main.py",
    "position": {
      "character": 5,
      "line": 10
    }
  },
  "full_scan": false
}
'

{
  "external_symbols": [
    {
      "file_range": {
        "path": "src/main.py",
        "range": {
          "end": {
            "character": 5,
            "line": 10
          },
          "start": {
            "character": 5,
            "line": 10
          }
        }
      },
      "name": "<string>",
      "kind": "<string>"
    }
  ],
  "not_found": [
    {
      "file_range": {
        "path": "src/main.py",
        "range": {
          "end": {
            "character": 5,
            "line": 10
          },
          "start": {
            "character": 5,
            "line": 10
          }
        }
      },
      "name": "<string>",
      "kind": "<string>"
    }
  ],
  "workspace_symbols": [
    {
      "definitions": [
        {
          "file_range": {
            "path": "src/main.py",
            "range": {
              "end": {
                "character": 5,
                "line": 10
              },
              "start": {
                "character": 5,
                "line": 10
              }
            }
          },
          "identifier_position": {
            "path": "src/main.py",
            "position": {
              "character": 5,
              "line": 10
            }
          },
          "kind": "class",
          "name": "User"
        }
      ],
      "reference": {
        "file_range": {
          "path": "src/main.py",
          "range": {
            "end": {
              "character": 5,
              "line": 10
            },
            "start": {
              "character": 5,
              "line": 10
            }
          }
        },
        "name": "<string>",
        "kind": "<string>"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Request to get all symbols that are referenced from a symbol at the given position, either focusing on function calls, or more permissively finding all references

The input position must point to a symbol (e.g. function name, class name, variable name). The response will include all symbols that are referenced from that input symbol. For example, if the position points to a function name, the response will include all symbols referenced within that function's implementation.

identifier_position

object

required

The identifier position of the symbol to find references within

Show child attributes

full_scan

boolean

Whether to use the more permissive rules to find referenced symbols. This will be not just code that is executed but also things like type hints and chained indirection. Defaults to false.

Example:

false

Response

Referenced symbols retrieved successfully

Response containing symbols referenced from the requested position

The symbols are categorized into:

workspace_symbols: References to symbols that were found and have definitions in the workspace
external_symbols: References to symbols from outside the workspace (built-in functions, external libraries)
not_found: References where the symbol definition could not be found

external_symbols

object[]

required

Show child attributes

not_found

object[]

required

Show child attributes

workspace_symbols

object[]

required

Show child attributes

Finds occurrences of an identifier by name in a file Find all references to a symbol

⌘I

symbol

system

workspace

Authorizations

Body

Response