proj_get_nets
Retrieve pin-level net-to-pin connectivity from a compiled project netlist; use one unfiltered call to pull all pin-net assignments for bulk component or net queries.
Instructions
Get net-to-pin connectivity from the compiled project netlist.
CRITICAL for bulk queries, if you need connectivity for MORE
THAN ONE component or net, do NOT loop this tool. Call it
ONCE with no filters (component="", net_name="", raise
limit if needed) to pull the entire pin-net table in a
single round-trip, then slice the result locally. Each
filtered call is ~700 ms and compiles the project.
Compiles the project and returns pin-level net assignments.
Args:
component: Filter by component designator. Empty = all.
net_name: Filter by net name. Empty = all.
project_path: Optional project path. If None, uses active.
limit: Max pin records (default 500). Raise for big boards.
force_recompile: Save all dirty docs, invalidate the
SmartCompile cache, recompile. Costs one extra
compile (~5-10 s on real designs). Use when you need
a guaranteed-fresh netlist (e.g., after the user
edited schematics in the UI). Pair with
proj_get_compile_freshness to confirm no docs are dirty.
Returns:
Dict with "pins", "count", "limit", "limit_hit" (true when
the list stopped at limit with pins left over) and
"skipped_nil" (entries Altium returned empty).
Examples: # PREFERRED, one unfiltered call, then filter locally: all_pins = proj_get_nets(limit=10000)["pins"] u1_pins = [p for p in all_pins if p["component"] == "U1"]
# Guaranteed-fresh read after user edits:
fresh = proj_get_nets(force_recompile=True, limit=10000)
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| net_name | No | ||
| component | No | ||
| project_path | No | ||
| force_recompile | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||