Read Package File
curl --request POST \
--url https://api.wistx.ai/v1/search/packages/read-file \
--header 'Content-Type: application/json' \
--data '
{
"registry": "<string>",
"package_name": "<string>",
"filename_sha256": "<string>",
"start_line": 123,
"end_line": 123,
"version": "<string>"
}
'import requests
url = "https://api.wistx.ai/v1/search/packages/read-file"
payload = {
"registry": "<string>",
"package_name": "<string>",
"filename_sha256": "<string>",
"start_line": 123,
"end_line": 123,
"version": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
registry: '<string>',
package_name: '<string>',
filename_sha256: '<string>',
start_line: 123,
end_line: 123,
version: '<string>'
})
};
fetch('https://api.wistx.ai/v1/search/packages/read-file', 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.wistx.ai/v1/search/packages/read-file",
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([
'registry' => '<string>',
'package_name' => '<string>',
'filename_sha256' => '<string>',
'start_line' => 123,
'end_line' => 123,
'version' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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.wistx.ai/v1/search/packages/read-file"
payload := strings.NewReader("{\n \"registry\": \"<string>\",\n \"package_name\": \"<string>\",\n \"filename_sha256\": \"<string>\",\n \"start_line\": 123,\n \"end_line\": 123,\n \"version\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.wistx.ai/v1/search/packages/read-file")
.header("Content-Type", "application/json")
.body("{\n \"registry\": \"<string>\",\n \"package_name\": \"<string>\",\n \"filename_sha256\": \"<string>\",\n \"start_line\": 123,\n \"end_line\": 123,\n \"version\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wistx.ai/v1/search/packages/read-file")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"registry\": \"<string>\",\n \"package_name\": \"<string>\",\n \"filename_sha256\": \"<string>\",\n \"start_line\": 123,\n \"end_line\": 123,\n \"version\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"package_name": "boto3",
"registry": "pypi",
"file_path": "boto3/s3/transfer.py",
"filename_sha256": "abc123def456...",
"start_line": 100,
"end_line": 150,
"total_lines": 500,
"content": "def upload_file(...):\n # Upload file implementation\n ...",
"line_count": 50
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0,
"query_time_ms": 234
}
}
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": "end_line must be >= start_line"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": "Maximum 200 lines can be read at once"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key",
"details": null
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred",
"details": "File with hash abc123def456... not found in package boto3"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
Search
Read Package File
Read specific file sections from package source code using SHA256 hash
POST
/
v1
/
search
/
packages
/
read-file
Read Package File
curl --request POST \
--url https://api.wistx.ai/v1/search/packages/read-file \
--header 'Content-Type: application/json' \
--data '
{
"registry": "<string>",
"package_name": "<string>",
"filename_sha256": "<string>",
"start_line": 123,
"end_line": 123,
"version": "<string>"
}
'import requests
url = "https://api.wistx.ai/v1/search/packages/read-file"
payload = {
"registry": "<string>",
"package_name": "<string>",
"filename_sha256": "<string>",
"start_line": 123,
"end_line": 123,
"version": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
registry: '<string>',
package_name: '<string>',
filename_sha256: '<string>',
start_line: 123,
end_line: 123,
version: '<string>'
})
};
fetch('https://api.wistx.ai/v1/search/packages/read-file', 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.wistx.ai/v1/search/packages/read-file",
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([
'registry' => '<string>',
'package_name' => '<string>',
'filename_sha256' => '<string>',
'start_line' => 123,
'end_line' => 123,
'version' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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.wistx.ai/v1/search/packages/read-file"
payload := strings.NewReader("{\n \"registry\": \"<string>\",\n \"package_name\": \"<string>\",\n \"filename_sha256\": \"<string>\",\n \"start_line\": 123,\n \"end_line\": 123,\n \"version\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.wistx.ai/v1/search/packages/read-file")
.header("Content-Type", "application/json")
.body("{\n \"registry\": \"<string>\",\n \"package_name\": \"<string>\",\n \"filename_sha256\": \"<string>\",\n \"start_line\": 123,\n \"end_line\": 123,\n \"version\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.wistx.ai/v1/search/packages/read-file")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"registry\": \"<string>\",\n \"package_name\": \"<string>\",\n \"filename_sha256\": \"<string>\",\n \"start_line\": 123,\n \"end_line\": 123,\n \"version\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"package_name": "boto3",
"registry": "pypi",
"file_path": "boto3/s3/transfer.py",
"filename_sha256": "abc123def456...",
"start_line": 100,
"end_line": 150,
"total_lines": 500,
"content": "def upload_file(...):\n # Upload file implementation\n ...",
"line_count": 50
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0,
"query_time_ms": 234
}
}
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": "end_line must be >= start_line"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": "Maximum 200 lines can be read at once"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key",
"details": null
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred",
"details": "File with hash abc123def456... not found in package boto3"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
Read exact file sections from package source code using SHA256 hash. Use this to get complete context around code snippets found in package searches. No indexing required - fetches packages on-demand from registries.
Endpoint
POST /v1/search/packages/read-file
Request Body
string
required
Package registry:
pypi, npm, terraform, crates_io, golang, helm, ansible, maven, nuget, rubygems.string
required
Package name.
string
required
SHA256 hash of filename (from search results).
integer
required
Starting line (1-based).
integer
required
Ending line (max 200 lines from start_line).
string
Optional package version.
Request Example
curl --request POST \
--url https://api.wistx.ai/v1/search/packages/read-file \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"registry": "pypi",
"package_name": "boto3",
"filename_sha256": "abc123def456...",
"start_line": 100,
"end_line": 150,
"version": "1.28.0"
}'
import requests
api_key = "YOUR_API_KEY"
response = requests.post(
"https://api.wistx.ai/v1/search/packages/read-file",
headers={
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json"
},
json={
"registry": "pypi",
"package_name": "boto3",
"filename_sha256": "abc123def456...",
"start_line": 100,
"end_line": 150,
"version": "1.28.0"
}
)
print(response.json())
const apiKey = "YOUR_API_KEY";
const response = await fetch("https://api.wistx.ai/v1/search/packages/read-file", {
method: "POST",
headers: {
"Authorization": `Bearer ${apiKey}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
registry: "pypi",
package_name: "boto3",
filename_sha256: "abc123def456...",
start_line: 100,
end_line: 150,
version: "1.28.0"
})
});
const data = await response.json();
console.log(data);
package main
import (
"bytes"
"encoding/json"
"net/http"
)
func main() {
apiKey := "YOUR_API_KEY"
payload := map[string]interface{}{
"registry": "pypi",
"package_name": "boto3",
"filename_sha256": "abc123def456...",
"start_line": 100,
"end_line": 150,
"version": "1.28.0",
}
jsonData, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", "https://api.wistx.ai/v1/search/packages/read-file", bytes.NewBuffer(jsonData))
req.Header.Set("Authorization", "Bearer "+apiKey)
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()
}
require 'net/http'
require 'json'
uri = URI('https://api.wistx.ai/v1/search/packages/read-file')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri.path)
request['Authorization'] = "Bearer YOUR_API_KEY"
request['Content-Type'] = 'application/json'
request.body = {
registry: "pypi",
package_name: "boto3",
filename_sha256: "abc123def456...",
start_line: 100,
end_line: 150,
version: "1.28.0"
}.to_json
response = http.request(request)
puts response.body
<?php
$apiKey = "YOUR_API_KEY";
$data = [
"registry" => "pypi",
"package_name" => "boto3",
"filename_sha256" => "abc123def456...",
"start_line" => 100,
"end_line" => 150,
"version" => "1.28.0"
];
$ch = curl_init("https://api.wistx.ai/v1/search/packages/read-file");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Authorization: Bearer " . $apiKey,
"Content-Type: application/json"
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
?>
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.URI;
import com.fasterxml.jackson.databind.ObjectMapper;
String apiKey = "YOUR_API_KEY";
Map<String, Object> payload = Map.of(
"registry", "pypi",
"package_name", "boto3",
"filename_sha256", "abc123def456...",
"start_line", 100,
"end_line", 150,
"version", "1.28.0"
);
ObjectMapper mapper = new ObjectMapper();
String json = mapper.writeValueAsString(payload);
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.wistx.ai/v1/search/packages/read-file"))
.header("Authorization", "Bearer " + apiKey)
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(json))
.build();
HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Response Example
{
"data": {
"package_name": "boto3",
"registry": "pypi",
"file_path": "boto3/s3/transfer.py",
"filename_sha256": "abc123def456...",
"start_line": 100,
"end_line": 150,
"total_lines": 500,
"content": "def upload_file(...):\n # Upload file implementation\n ...",
"line_count": 50
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0,
"query_time_ms": 234
}
}
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": "end_line must be >= start_line"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters",
"details": "Maximum 200 lines can be read at once"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid or missing API key",
"details": null
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
{
"error": {
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred",
"details": "File with hash abc123def456... not found in package boto3"
},
"metadata": {
"request_id": "req_abc123",
"timestamp": 1704067200.0
}
}
Rate Limits
| Plan | Queries/Month |
|---|---|
| Professional | 2,000 |
| Team | 10,000 |
| Enterprise | Unlimited |