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
}
'import requests
url = "http://localhost:4444/v1/symbol/find-referenced-symbols"
payload = {
"identifier_position": {
"path": "src/main.py",
"position": {
"character": 5,
"line": 10
}
},
"full_scan": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
identifier_position: {path: 'src/main.py', position: {character: 5, line: 10}},
full_scan: false
})
};
fetch('http://localhost:4444/v1/symbol/find-referenced-symbols', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "4444",
CURLOPT_URL => "http://localhost:4444/v1/symbol/find-referenced-symbols",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'identifier_position' => [
'path' => 'src/main.py',
'position' => [
'character' => 5,
'line' => 10
]
],
'full_scan' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:4444/v1/symbol/find-referenced-symbols"
payload := strings.NewReader("{\n \"identifier_position\": {\n \"path\": \"src/main.py\",\n \"position\": {\n \"character\": 5,\n \"line\": 10\n }\n },\n \"full_scan\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:4444/v1/symbol/find-referenced-symbols")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"identifier_position\": {\n \"path\": \"src/main.py\",\n \"position\": {\n \"character\": 5,\n \"line\": 10\n }\n },\n \"full_scan\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:4444/v1/symbol/find-referenced-symbols")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"identifier_position\": {\n \"path\": \"src/main.py\",\n \"position\": {\n \"character\": 5,\n \"line\": 10\n }\n },\n \"full_scan\": false\n}"
response = http.request(request)
puts response.read_body{
"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
}
'import requests
url = "http://localhost:4444/v1/symbol/find-referenced-symbols"
payload = {
"identifier_position": {
"path": "src/main.py",
"position": {
"character": 5,
"line": 10
}
},
"full_scan": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
identifier_position: {path: 'src/main.py', position: {character: 5, line: 10}},
full_scan: false
})
};
fetch('http://localhost:4444/v1/symbol/find-referenced-symbols', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "4444",
CURLOPT_URL => "http://localhost:4444/v1/symbol/find-referenced-symbols",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'identifier_position' => [
'path' => 'src/main.py',
'position' => [
'character' => 5,
'line' => 10
]
],
'full_scan' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:4444/v1/symbol/find-referenced-symbols"
payload := strings.NewReader("{\n \"identifier_position\": {\n \"path\": \"src/main.py\",\n \"position\": {\n \"character\": 5,\n \"line\": 10\n }\n },\n \"full_scan\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:4444/v1/symbol/find-referenced-symbols")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"identifier_position\": {\n \"path\": \"src/main.py\",\n \"position\": {\n \"character\": 5,\n \"line\": 10\n }\n },\n \"full_scan\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:4444/v1/symbol/find-referenced-symbols")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"identifier_position\": {\n \"path\": \"src/main.py\",\n \"position\": {\n \"character\": 5,\n \"line\": 10\n }\n },\n \"full_scan\": false\n}"
response = http.request(request)
puts response.read_body{
"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
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.
The identifier position of the symbol to find references within
Show child attributes
Show child attributes
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