Skip to main content
POST
/
symbol
/
find-references
Find all references to a symbol
curl --request POST \
  --url http://localhost:4444/v1/symbol/find-references \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "identifier_position": {
    "path": "src/main.py",
    "position": {
      "character": 5,
      "line": 10
    }
  },
  "include_code_context_lines": 5,
  "include_raw_response": false
}'
{
  "context": [
    {
      "range": {
        "path": "src/main.py",
        "range": {
          "end": {
            "character": 5,
            "line": 10
          },
          "start": {
            "character": 5,
            "line": 10
          }
        }
      },
      "source_code": "<string>"
    }
  ],
  "raw_response": "<any>",
  "references": [
    {
      "path": "src/main.py",
      "position": {
        "character": 5,
        "line": 10
      }
    }
  ],
  "selected_identifier": {
    "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
include_code_context_lines
integer | null
Required range: x >= 0
Example:
include_raw_response
boolean
Example:

Response

references
object[]
required
selected_identifier
object
required
context
object[] | null
raw_response
any