Find symbol references

Returns all locations in the codebase where the given symbol is referenced.

POST /api/find_references

Find symbol references

cURL

curl --request POST \
  --url https://api.example.com/api/find_references \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "symbolName": "<string>",
  "language": "<string>",
  "revisionName": "<string>",
  "repoName": "<string>"
}
'

import requests

url = "https://api.example.com/api/find_references"

payload = {
    "symbolName": "<string>",
    "language": "<string>",
    "revisionName": "<string>",
    "repoName": "<string>"
}
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({
    symbolName: '<string>',
    language: '<string>',
    revisionName: '<string>',
    repoName: '<string>'
  })
};

fetch('https://api.example.com/api/find_references', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/find_references",
  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([
    'symbolName' => '<string>',
    'language' => '<string>',
    'revisionName' => '<string>',
    'repoName' => '<string>'
  ]),
  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 := "https://api.example.com/api/find_references"

	payload := strings.NewReader("{\n  \"symbolName\": \"<string>\",\n  \"language\": \"<string>\",\n  \"revisionName\": \"<string>\",\n  \"repoName\": \"<string>\"\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("https://api.example.com/api/find_references")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"symbolName\": \"<string>\",\n  \"language\": \"<string>\",\n  \"revisionName\": \"<string>\",\n  \"repoName\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/find_references")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"symbolName\": \"<string>\",\n  \"language\": \"<string>\",\n  \"revisionName\": \"<string>\",\n  \"repoName\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "stats": {
    "matchCount": 123
  },
  "files": [
    {
      "fileName": "<string>",
      "repository": "<string>",
      "repositoryId": 123,
      "webUrl": "<string>",
      "language": "<string>",
      "matches": [
        {
          "lineContent": "<string>",
          "range": {
            "start": {
              "byteOffset": 123,
              "lineNumber": 123,
              "column": 123
            },
            "end": {
              "byteOffset": 123,
              "lineNumber": 123,
              "column": 123
            }
          }
        }
      ]
    }
  ],
  "repositoryInfo": [
    {
      "id": 123,
      "name": "<string>",
      "displayName": "<string>",
      "webUrl": "<string>"
    }
  ]
}

{
  "statusCode": 123,
  "errorCode": "<string>",
  "message": "<string>"
}

{
  "statusCode": 123,
  "errorCode": "<string>",
  "message": "<string>"
}

Authorizations

bearerTokenapiKeyHeader

Authorization · string · header · required

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

Body

application/json

symbolName · string · required

language · string

revisionName · string

repoName · string

Response

200

application/json

Symbol reference locations.

stats · object · required

Show child attributes

files · object[] · required

Show child attributes

repositoryInfo · object[] · required

Show child attributes