Autoscrape SDK
AutoScrape Data API client, generated from the OpenAPI spec.
No-key evaluation REST API plus paid x402 mirrors for US public-data evidence: business filings across 16 no-key states, building permits, SEC EDGAR, IRS 990 nonprofits, WHOIS domain lookup, and stock price data.
Learn more about AutoScrape Data API at autoscrape-api-seven.vercel.app.
This is an unofficial SDK for the AutoScrape Data public API, generated by Voxgig with @voxgig/sdkgen. It is not affiliated with, endorsed by, or sponsored by the upstream API provider.
Learn more about Voxgig SDKs at voxgig.com/sdk.
Metadata kindly supplied by www.freepublicapis.com.
TypeScript, Python, PHP, Golang, Ruby, Lua SDKs, a CLI, an interactive REPL, and an MCP server for AI agents — all generated from one OpenAPI spec by @voxgig/sdkgen.
Entities, not endpoints
This SDK exposes the API as 7 semantic entities that you
call directly, instead of assembling URL paths and query strings. See the Entities table below for the full list. Entities are
Capitalised to mark them as the primary surface, each with the operations they
support (load):
const client = new AutoscrapeSDK()
const buildingpermit = await client.BuildingPermit().load()
Thinking in entities keeps the mental model small — for people and AI agents alike — rather than reasoning about raw HTTP routes and query parameters.
Offline unit testing
Every SDK ships a built-in test mode that swaps the HTTP transport for an in-memory mock, so your unit tests run fully offline — no server, no network, and no credentials:
TypeScript
const client = AutoscrapeSDK.test()
const buildingpermit = await client.BuildingPermit().load()
// buildingpermit is a bare BuildingPermit populated with mock data
console.log(buildingpermit)
Python
client = AutoscrapeSDK.test()
buildingpermit = client.BuildingPermit().load()
print(buildingpermit)
PHP
// Seed fixture data so offline calls resolve without a live server.
$client = AutoscrapeSDK::test([
"entity" => ["buildingpermit" => ["test01" => []]],
]);
$buildingpermit = $client->BuildingPermit()->load();
Golang
client := sdk.Test()
result, err := client.BuildingPermit(nil).Load(
nil, nil,
)
Ruby
# Seed fixture data so offline calls resolve without a live server.
client = AutoscrapeSDK.test({
"entity" => { "buildingpermit" => { "test01" => {} } },
})
buildingpermit = client.BuildingPermit.load()
Lua
local client = sdk.test()
local result, err = client:BuildingPermit():load()
Packages
| Language | Package | Install |
|---|---|---|
| TypeScript | @voxgig-sdk/autoscrape | publish pending — install from git tag |
| Python | voxgig-sdk-autoscrape | publish pending — install from git tag |
| PHP | voxgig-sdk/autoscrape | publish pending — install from git tag |
| Golang | github.com/voxgig-sdk/autoscrape-sdk/go | go get github.com/voxgig-sdk/autoscrape-sdk/go@latest |
| Ruby | voxgig-sdk-autoscrape | publish pending — install from git tag |
| Lua | voxgig-sdk-autoscrape | publish pending — install from git tag |
| Go CLI | github.com/voxgig-sdk/autoscrape-sdk/go-cli | go install github.com/voxgig-sdk/autoscrape-sdk/go-cli/cmd/autoscrape@latest |
| Go MCP server | github.com/voxgig-sdk/autoscrape-sdk/go-mcp | go get github.com/voxgig-sdk/autoscrape-sdk/go-mcp@latest |
Quickstart
TypeScript
import { AutoscrapeSDK } from '@voxgig-sdk/autoscrape'
const client = new AutoscrapeSDK()
// Load buildingpermit data (returns a BuildingPermit)
const buildingpermit = await client.BuildingPermit().load()
console.log(buildingpermit)
See the TypeScript README for the full guide.
Surfaces
| Surface | Path |
|---|---|
| SDK (TypeScript, Python, PHP, Golang, Ruby, Lua) | ts/ py/ php/ go/ rb/ lua/ |
| CLI | go-cli/ |
| MCP server | go-mcp/ |
Use it from an AI agent (MCP)
The generated MCP server exposes every operation in this SDK as an MCP tool that Claude, Cursor or Cline can call directly. Build and register it:
cd go-mcp && go build -o autoscrape-mcp .
Then add it to your agent’s MCP config (Claude Desktop, Cursor, etc.):
{
"mcpServers": {
"autoscrape": {
"command": "/abs/path/to/autoscrape-mcp"
}
}
}
Entities
The API exposes 7 entities:
| Entity | Description | API path |
|---|---|---|
| BuildingPermit | The BuildingPermit entity (load). | /v1/building-permits/search |
| BusinessEntity | The BusinessEntity entity (load). | /v1/business-entity/search |
| Irs990 | The Irs990 entity (load). | /v1/irs-990/search |
| SecEdgar | The SecEdgar entity (load). | /v1/sec-edgar/filings |
| StockData | The StockData entity (load). | /v1/stock/chart |
| Whoi | The Whoi entity (load). | /v1/whois/lookup |
| X402Paid | The X402Paid entity (load). | /x402/v1/sec-edgar/filings |
The operations available across these entities are load — see each entity’s own list above for exactly which it supports.
Quickstart in other languages
Python
from autoscrape_sdk import AutoscrapeSDK
client = AutoscrapeSDK()
# Load a specific buildingpermit (returns the record, raises on error)
buildingpermit = client.BuildingPermit().load()
print(buildingpermit)
PHP
<?php
require_once 'autoscrape_sdk.php';
$client = new AutoscrapeSDK();
// Load a specific buildingpermit (returns the bare record; throws on error)
$buildingpermit = $client->BuildingPermit()->load();
print_r($buildingpermit);
Golang
import sdk "github.com/voxgig-sdk/autoscrape-sdk/go"
client := sdk.New()
// Load buildingpermit data
buildingPermit, err := client.BuildingPermit(nil).Load(nil, nil)
if err != nil {
panic(err)
}
fmt.Println(buildingPermit)
Ruby
require_relative "Autoscrape_sdk"
client = AutoscrapeSDK.new
# Load a specific buildingpermit (returns the bare record; raises on error)
buildingpermit = client.BuildingPermit.load()
puts buildingpermit
Lua
local sdk = require("autoscrape_sdk")
local client = sdk.new()
-- Load a specific buildingpermit
local buildingpermit, err = client:BuildingPermit():load()
print(buildingpermit)
Direct and prepare
For endpoints the entity model doesn’t cover, use the low-level methods:
direct(fetchargs)— build and send an HTTP request in one step.prepare(fetchargs)— build the request without sending it.
Both accept a map with path, method, params, query,
headers, and body. See the How-to guides below.
How-to guides
Make a direct API call
When the entity interface does not cover an endpoint, use direct:
TypeScript:
const result = await client.direct({
path: '/api/resource/{id}',
method: 'GET',
params: { id: 'example' },
})
if (result instanceof Error) {
throw result
}
console.log(result.data)
Python:
result = client.direct({
"path": "/api/resource/{id}",
"method": "GET",
"params": {"id": "example"},
})
PHP:
$result = $client->direct([
"path" => "/api/resource/{id}",
"method" => "GET",
"params" => ["id" => "example"],
]);
Go:
result, err := client.Direct(map[string]any{
"path": "/api/resource/{id}",
"method": "GET",
"params": map[string]any{"id": "example"},
})
if err != nil {
panic(err)
}
fmt.Println(result)
Ruby:
result = client.direct({
"path" => "/api/resource/{id}",
"method" => "GET",
"params" => { "id" => "example" },
})
Lua:
local result, err = client:direct({
path = "/api/resource/{id}",
method = "GET",
params = { id = "example" },
})
Advanced
Everyday use only needs the sections above. This explains the internals behind every call — relevant when writing custom features.
Every SDK call runs the same five-stage pipeline:
- Point — resolve the API endpoint from the operation definition.
- Spec — build the HTTP specification (URL, method, headers, body).
- Request — send the HTTP request.
- Response — receive and parse the response.
- Result — extract the result data for the caller.
A feature hook fires at each stage (e.g. PrePoint, PreSpec,
PreRequest), so features can inspect or modify the pipeline without
forking the SDK.
Features
| Feature | Purpose |
|---|---|
| TestFeature | In-memory mock transport for testing without a live server |
Pass custom features via the extend option at construction time.
Per-language documentation
Upstream API
This SDK is generated from the upstream OpenAPI specification. It is an unofficial client and is not affiliated with the API provider.
- Upstream API: https://www.payapi.market/provider/ava-torres
Security
Please report security issues to security@voxgig.com. See SECURITY.md. Do not open public issues for suspected vulnerabilities.
Generated from the AutoScrape Data API OpenAPI spec by @voxgig/sdkgen.