API Reference

Provide or Overwrite The XYRS Data for the PCB Version

By Default, the Bill of Materials and Placement Data express the EDA-defined
data about your board. This data is essential for the production of your
PCB. Within this data is critical information about each component, it's
X and Y center (in thousandths of an inch), and the pad width and height
of the component (in thousandths of an inch).

This method completely overwrites the existing XYRS data for the specified
version of the PCB project, or provides the data if it does not exist.

You must provide for each component all of the following values:

  • designator
    • The unique designator for the component
    • e.g.: 'R1', 'C23', etc.
  • x_loc
    • The X-location of the center of the component, in thousandths of an inch
    • 0,0 location is the bottom-left of the PCB at the center of the board outline
    • e.g.: 1023, 59.5, etc.
  • y_loc
    • The Y-location of the center of the component, in thousandths of an inch
    • 0,0 location is the bottom-left of the PCB at the center of the board outline
    • e.g.: 1023, 59.5, etc.
  • rotation
    • The rotation of the component
    • Rotation is clockwise
    • Zero rotation (0) assumes that locating pin on the component is at or nearest to the top-left, 180 assumes bottom-right
  • board_side
    • Which side of the board the component is on
    • 1 = top, 2 = bottom
  • component_type
    • What type of component is this?
    • 1 = SMD, 2 = PTH
  • x_size
    • The width of a box which just contains all pads (e.g. the "pad width") in thousandths of an inch
    • This data is used to display the component on the placement tab in the UI
    • If you cannot extract this data from your EDA tool, specify any value which is neither too large nor too small to effectively manage rotation in the UI
  • y_size
    • The height of a box which just contains all pads (e.g. the "pad height") in thousandths of an inch
    • This data is used to display the component on the placement tab in the UI
    • If you cannot extract this data from your EDA tool, specify any value which is neither too large nor too small to effectively manage rotation in the UI
  • value
    • The component value
    • The system will automatically match this field for a manufacturer's part number and select that component if it is available on the market
      • To perform automatic matching, provide the exact part number, e.g. "FOO-12235.111/EX"
    • For parts such as resistors and capacitors, the system will automatically combine the value and footprint to search for "nearest compatible" house parts
  • footprint
    • The footprint for the part
    • e.g. "R0402", "C0603", "SOT-23-3", etc.
Language
Authorization
Query
Click Try It! to start a request and see the response here!