Skip to main content
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 '{
  "full_scan": false,
  "identifier_position": {
    "path": "src/main.py",
    "position": {
      "character": 5,
      "line": 10
    }
  }
}'
{
  "external_symbols": [
    {
      "file_range": {
        "path": "src/main.py",
        "range": {
          "end": {
            "character": 5,
            "line": 10
          },
          "start": {
            "character": 5,
            "line": 10
          }
        }
      },
      "kind": "<string>",
      "name": "<string>"
    }
  ],
  "not_found": [
    {
      "file_range": {
        "path": "src/main.py",
        "range": {
          "end": {
            "character": 5,
            "line": 10
          },
          "start": {
            "character": 5,
            "line": 10
          }
        }
      },
      "kind": "<string>",
      "name": "<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
            }
          }
        },
        "kind": "<string>",
        "name": "<string>"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Body

application/json
identifier_position
object
required
full_scan
boolean
Example:

Response

external_symbols
object[]
required
not_found
object[]
required
workspace_symbols
object[]
required