Check connectivity to the running KiCad IPC server.

Get KiCad connection status and version information.

List documents currently open in KiCad.

Get KiCad and API version details.

Run a KiCad editor action by name (unstable API).

Get summary information about the open PCB.

Get bounding box size of the board outline in mm.

Get the board file contents as a KiCad S-expression string.

Get current selection as KiCad S-expression string.

List all footprint instances on the board.

Get a component by reference designator.

List all tracks and arc tracks.

List all vias.

List all pads on the board.

List all nets, optionally filtered by net class.

List all copper and rule zones.

List all item groups on the board.

List all dimension objects.

List all board text and text boxes.

List graphic shapes (segments, arcs, rects, etc.).

List barcode objects on the board.

Retrieve board items by their KiCad UUID.

Retrieve items belonging to a net.

Get all copper-connected items from a starting item.

Get the board layer stackup.

Get board title block fields.

Save the current board, optionally to a new path.

Revert board to last saved state.

Place a footprint on the board.

Move a component to a new position.

Rotate a component by a relative angle.

Delete a component by reference.

Add a copper trace between two points.

Add a through-hole via.

Add a copper pour zone from polygon points.

Refill all copper zones.

Add silkscreen or copper text.

Add board outline segments on Edge.Cuts.

Add circular mounting hole on Edge.Cuts.

Create rectangular board outline.

Delete board items by UUID.

Update board title block fields.

List all enabled board layers.

List layers visible in the editor.

Get the active drawing layer.

Set the active drawing layer.

Set which layers are visible in the editor.

Get number of copper layers.

Set copper layer count and enabled non-copper layers (destructive).

Get display name for a layer.

Get currently selected board items.

Add items to selection by UUID.

Remove items from selection.

Clear the editor selection.

Get bounding box for a board item.

Test if a point hits a board item.

Get grid or drill origin.

Set grid or drill origin.

Get PCB editor appearance settings.

Get project net classes.

Get project text variables.

Set project text variables.

Expand ${VAR} placeholders in text strings.

Export Gerber manufacturing files.

Export Excellon drill files.

Export board as PDF.

Export board as SVG.

Export board as DXF.

Export 3D model (STEP, GLB, STL, etc.).

Export pick-and-place position files.

Export IPC-2581 package.

Export ODB++ package.

Export board statistics report.

Browse all KiCad IPC tool categories and their tools.

Search KiCad IPC tools by name, description, or category.

Get the parameter schema for a KiCad IPC tool.

Execute any KiCad IPC tool by name with a JSON arguments object.