Endpoint reference

Work in progress
We are working to expand the PartBolt API. New endpoints are added based on customer requests. If there is something you'd like that isn't available, please contact us at [email protected] - we'll add any endpoint you need.
GET parts/get

Gets information for the part with the given ID. Requires parts:read scope.

Parameters:

  • id (integer, required) - The ID for the part.
View sample response
GET https://api-public-v1.partbolt.com/parts/get?id=1486 
{
  "status": "ok",
  "data": {
    "part": {
      "id": 1484,
      "code": "4pha3kv7pf",
      "localNumber": "LMV358IDGKR",
      "mpn": "LMV358IDGKR",
      "name": "Op-amp, Dual, 5.5V, Rail-to-Rail",
      "currentStock": 3,
      "archived": false,
      "manufacturer": {
        "id": 559,
        "name": "Texas Instruments",
        "archived": false
      },
      "package": {
        "id": 294,
        "name": "VSSOP-8",
        "archived": false
      }
    },
    "lots": [
      {
        "id": 2495,
        "code": "kzxf29e477",
        "partID": 1484,
        "location": {
          "id": 558,
          "name": "Shelf C",
          "code": "rnr79tjtkx",
          "archived": false
        },
        "description": "",
        "currentStock": 3
      }
    ]
  }
}
GET parts/get_all

Gets information for every part in the database. The response may be quite large - avoid calling this endpoint frequently! Requires parts:read scope.

View sample response
GET https://api-public-v1.partbolt.com/parts/get_all 
{
  "status": "ok",
  "data": {
    "parts": [
      {
        "id": 1467,
        "code": "9xtwarxxwf",
        "localNumber": "1N4148W-7-F",
        "mpn": "1N4148W-7-F",
        "name": "Diode, Signal, 300 mA",
        "currentStock": 6,
        "archived": false,
        "manufacturer": {
          "id": 551,
          "name": "Diodes Inc.",
          "archived": false
        },
        "package": {
          "id": 290,
          "name": "SOD-123",
          "archived": false
        }
      },
      {
        "id": 1355,
        "code": "53ehtzezxr",
        "localNumber": "1909763-1",
        "mpn": "1909763-1",
        "name": "Connector, Coaxial, u.FL/UMCC, 50 ohm",
        "currentStock": 0,
        "archived": false,
        "manufacturer": {
          "id": 495,
          "name": "TE Connectivity",
          "archived": false
        },
        "package": null
      },
      {
        "id": 1486,
        "code": "jy3jf7yxjp",
        "localNumber": "ATMEGA16U2-MU",
        "mpn": "ATMEGA16U2-MU",
        "name": "MCU, 8-bit, AVR, 16KB Flash, 512B RAM, 16 MHz, 2.7 to 5.5V",
        "currentStock": 4,
        "archived": false,
        "manufacturer": {
          "id": 496,
          "name": "Microchip",
          "archived": false
        },
        "package": {
          "id": 296,
          "name": "VQFN-32",
          "archived": false
        }
      },
      {
        "id": 1487,
        "code": "nv2bjdxpp7",
        "localNumber": "ATMEGA328P-PU",
        "mpn": "ATMEGA328P-PU",
        "name": "MCU, 8-bit, AVR, 32KB Flash, 2KB RAM, 20MHz, 1.8 to 5.5V",
        "currentStock": 0,
        "archived": false,
        "manufacturer": {
          "id": 496,
          "name": "Microchip",
          "archived": false
        },
        "package": {
          "id": 297,
          "name": "DIP-28",
          "archived": false
        }
      },
      {
        "id": 1484,
        "code": "4pha3kv7pf",
        "localNumber": "LMV358IDGKR",
        "mpn": "LMV358IDGKR",
        "name": "Op-amp, Dual, 5.5V, Rail-to-Rail",
        "currentStock": 3,
        "archived": false,
        "manufacturer": {
          "id": 559,
          "name": "Texas Instruments",
          "archived": false
        },
        "package": {
          "id": 294,
          "name": "VSSOP-8",
          "archived": false
        }
      }
    ]
  }
}
GET parts/search

Searches through the database for parts matching the given query. Requires parts:read scope.

Parameters:

  • query (string, required) - The search query.
View sample response
GET https://api-public-v1.partbolt.com/parts/search?query=MCU 
{
  "status": "ok",
  "data": {
    "parts": [
      {
        "id": 1486,
        "code": "jy3jf7yxjp",
        "localNumber": "ATMEGA16U2-MU",
        "mpn": "ATMEGA16U2-MU",
        "name": "MCU, 8-bit, AVR, 16KB Flash, 512B RAM, 16 MHz, 2.7 to 5.5V",
        "currentStock": 4,
        "archived": false,
        "manufacturer": {
          "id": 496,
          "name": "Microchip",
          "archived": false
        },
        "package": {
          "id": 296,
          "name": "VQFN-32",
          "archived": false
        }
      },
      {
        "id": 1487,
        "code": "nv2bjdxpp7",
        "localNumber": "ATMEGA328P-PU",
        "mpn": "ATMEGA328P-PU",
        "name": "MCU, 8-bit, AVR, 32KB Flash, 2KB RAM, 20MHz, 1.8 to 5.5V",
        "currentStock": 0,
        "archived": false,
        "manufacturer": {
          "id": 496,
          "name": "Microchip",
          "archived": false
        },
        "package": {
          "id": 297,
          "name": "DIP-28",
          "archived": false
        }
      }
    ]
  }
}