REST API Reference (V3)

Octopart APIv3 and Nexar Legacy API REST can be accessed by sending HTTP requests to the following HTTP endpoints:

/brands

• GET /brands/{uid} - Fetch a brand by primary key
  • Description

    This method returns individual brands by primary key. The fetch key for a brand is its 'uid'.

    URL Arguments

    See Universal URL Arguments.

    Response Object

    This method returns a <Brand object>.

  • Examples
    • Python

      import json
      import urllib
      
      url = 'http://octopart.com/api/v3/brands/2239e3330e2df5fe'
      url += "?apikey=REPLACE_ME"
      
      data = urllib.urlopen(url).read()
      brand = json.loads(data)
      
      # print name
      print brand['name']
      

      Download examples/brands_get.py »
    • Ruby

      require 'rubygems'
      require 'json'
      require 'net/http'
      
      url = "http://octopart.com/api/v3/brands/2239e3330e2df5fe"
      url += "?apikey=REPLACE_ME"
      
      resp = Net::HTTP.get_response(URI.parse(url))
      brand = JSON.parse(resp.body)
      
      # print name
      puts brand['name']
      

      Download examples/brands_get.rb »
    • JavaScript

      <script src="http://code.jquery.com/jquery-1.11.0.js"></script>
      <script>
          var url = "http://octopart.com/api/v3/brands/2239e3330e2df5fe";
          url += "?apikey=REPLACE_ME";
          url += "&callback=?";
      
          $.getJSON(url, function(brand) {
              // print name
              console.log(brand['name']);
          });
      </script>
      

      Download examples/brands_get.html »
    • C Sharp

      namespace OctopartApi
      {
          using Newtonsoft.Json;
          using RestSharp;
          using System;
      
          public static class BrandsGet
          {
              public static void ExecuteSearch()
              {
                  // -- your search query --
                  string id = "2239e3330e2df5fe";
      
                  string octopartUrlBase = "http://octopart.com/api/v3";
                  string octopartUrlEndpoint = "brands/{id}";
                  string apiKey = APIKEY;
      
                  // Create the search request
                  var client = new RestClient(octopartUrlBase);
                  var req = new RestRequest(octopartUrlEndpoint, Method.GET)
                              .AddParameter("apikey", apiKey)
                              .AddUrlSegment("id", id);
      
                  // Perform the search and obtain results
                  var data = client.Execute(req).Content;
                  var brand = JsonConvert.DeserializeObject<dynamic>(data);
      
                  // Print the brand display name
                  Console.WriteLine(brand["name"]);
              }
      
              // -- your API key -- (https://octopart.com/api/register)
              private const string APIKEY = "REPLACE_ME";
          }
      }
      

      Download examples/brands_get.cs »
    • VB.NET

      Imports Newtonsoft.Json
      Imports RestSharp
      Imports System
      
      Public Module BrandsGet
          Public Sub ExecuteSearch()
              ' -- your search query --
              Dim id As String = "2239e3330e2df5fe"
      
              Dim octopartUrlBase As String = "http://octopart.com/api/v3"
              Dim octopartUrlEndpoint As String = "brands/{id}"
              Dim apiKey As String = BrandsGet.APIKEY
      
              ' Create the search request
              Dim client = New RestClient(octopartUrlBase)
              Dim req = New RestRequest(octopartUrlEndpoint, Method.GET) _
                              .AddParameter("apikey", apiKey) _
                              .AddUrlSegment("id", id)
      
              ' Perform the search and obtain results
              Dim data = client.Execute(req).Content
              Dim brand = JsonConvert.DeserializeObject(data)
      
              ' Print the brand display name
              Console.WriteLine(brand("name"))
          End Sub
      
          ' -- your API key -- (https:'octopart.com/api/register)
          Private Const APIKEY As String = "REPLACE_ME"
      End Module
      

      Download examples/brands_get.vb »
  • HTTP Responses

    These are some common HTTP responses and their likely causes:

    • 200 OK: Brand was fetched successfuly
    • 404 Not Found: The brand does not exist

• GET /brands/search - Search across brands
  • Description

    This method allows searching across brands by keyword. This is the ideal method to use to go from a brand alias or keyword to a Octopart brand instance

    URL Arguments

    Argument	Datatype	Default
    q	string	""
    start	integer	0
    limit	integer	10
    sortby	string	"score desc"
    filter[fields][<fieldname>][]	string	""
    filter[queries][]	string	""
    facet[fields][<fieldname>][include]	boolean	false
    facet[fields][<fieldname>][exclude_filter]	boolean	false
    facet[fields][<fieldname>][start]	integer	0
    facet[fields][<fieldname>][limit]	integer	10
    facet[queries][]	string	""
    stats[<fieldname>][include]	boolean	false
    stats[<fieldname>][exclude_filter]	boolean	false

    • q
      Full-text query string
    • start
      Ordinal position of first result. First position is 0. Maximum is 1000.
    • limit
      Maximum number of results to return. Default is 10. Maximum is 100.
    • sortby
      Comma separated list of (fieldname, fieldorder) pairs
    • filter[fields][<fieldname>][]
      Attribute (fieldname/fieldvalue) pair to filter results on
    • filter[queries][]
      Arbitrary filter query string
    • facet[fields][<fieldname>][include]
      If specified, perform faceting on given <fieldname>
    • facet[fields][<fieldname>][exclude_filter]
      If specified, remove <fieldname> from filters when calculating facets for <fieldname>
    • facet[fields][<fieldname>][start]
      Ordinal position of first facet to return. First position is 0. Maximum is 1000.
    • facet[fields][<fieldname>][limit]
      Number of facets to return. Default is 10. Maximum is 100.
    • facet[queries][]
      Arbitrary filter query string to facet on
    • stats[<fieldname>][include]
      If specified, calculate statistics for <fieldname
    • stats[<fieldname>][exclude_filter]
      If specified, remove <fieldname> from filters when calculating statistics for <fieldname>

    See Universal URL Arguments.

    Searchable Fields

    Fieldname	Description
    name	Brand name

    Response Object

    This method returns a <SearchResponse object>.

  • Examples
    • Python

      import json
      import urllib
      
      url = "http://octopart.com/api/v3/brands/search"
      url += "?apikey=REPLACE_ME"
      
      args = [
         ('q', 'texas'),
         ('start', 0),
         ('limit', 10)
         ]
      
      url += '&' + urllib.urlencode(args)
      
      data = urllib.urlopen(url).read()
      search_response = json.loads(data)
      
      # print number of hits
      print search_response['hits']
      
      # print results
      for result in search_response['results']:
         # print matched brand
         print result['item']['name']
      

      Download examples/brands_search.py »
    • Ruby

      require 'rubygems'
      require 'json'
      require 'net/http'
      
      url = "http://octopart.com/api/v3/brands/search"
      url += "?apikey=REPLACE_ME"
      
      def to_query(hsh)
        hsh.map {|k, v| "#{k}=#{URI.encode(v.to_s)}"}.join("&")
      end
      
      params = {
        :q =>"texas",
        :start => 0,
        :limit => 10
      }
      
      url += "&" + to_query(params)
      
      resp = Net::HTTP.get_response(URI.parse(url))
      search_response = JSON.parse(resp.body)
      
      # print number of hits
      puts search_response['hits']
      
      # print results
      search_response['results'].each do |result|
        # print matched brand
        puts result['item']['name']
      end
      

      Download examples/brands_search.rb »
    • JavaScript

      <script src="http://code.jquery.com/jquery-1.11.0.js"></script>
      <script>
          var url = "http://octopart.com/api/v3/brands/search";
          url += "?apikey=REPLACE_ME";
          url += "&callback=?";
      
          var args = {
              q: "texas",
              start: 0,
              limit: 10
          };
      
          $.getJSON(url, args, function(search_response) {
              // print original request
              console.log(search_response['request']);
      
              // iterate through results
              $.each(search_response['results'], function(i, result){
                  // print matched brand items
                  console.log(result['item']['name']);
              });
          });
      </script>
      

      Download examples/brands_search.html »
    • C Sharp

      namespace OctopartApi
      {
          using Newtonsoft.Json;
          using RestSharp;
          using System;
      
          public static class BrandsSearch
          {
              public static void ExecuteSearch()
              {
                  // -- your search query --
                  string query = "texas";
      
                  string octopartUrlBase = "http://octopart.com/api/v3";
                  string octopartUrlEndpoint = "brands/search";
                  string apiKey = APIKEY;
      
                  // Create the search request
                  var client = new RestClient(octopartUrlBase);
                  var req = new RestRequest(octopartUrlEndpoint, Method.GET)
                              .AddParameter("apikey", apiKey)
                              .AddParameter("q", query)
                              .AddParameter("start", "0")
                              .AddParameter("limit", "10");
      
                  // Perform the search and obtain results
                  var data = client.Execute(req).Content;
                  var search_response = JsonConvert.DeserializeObject<dynamic>(data);
      
                  // Print the number of hits
                  Console.WriteLine(search_response["hits"]);
      
                  // Print results
                  foreach (var result in search_response["results"])
                  {
                      // Print matched brand
                      Console.WriteLine(result["item"]["name"]);
                  }
              }
      
              // -- your API key -- (https://octopart.com/api/register)
              private const string APIKEY = "REPLACE_ME";
          }
      }
      

      Download examples/brands_search.cs »
    • VB.NET

      Imports Newtonsoft.Json
      Imports RestSharp
      Imports System
      
      Public Module BrandsSearch
          Public Sub ExecuteSearch()
              ' -- your search query --
              Dim query As String = "texas"
      
              Dim octopartUrlBase As String = "http://octopart.com/api/v3"
              Dim octopartUrlEndpoint As String = "brands/search"
              Dim apiKey As String = BrandsSearch.APIKEY
      
              ' Create the search request
              Dim client = New RestClient(octopartUrlBase)
              Dim req = New RestRequest(octopartUrlEndpoint, Method.GET) _
                              .AddParameter("apikey", apiKey) _
                              .AddParameter("q", query) _
                              .AddParameter("start", "0") _
                              .AddParameter("limit", "10")
      
              ' Perform the search and obtain results
              Dim data = client.Execute(req).Content
              Dim search_response = JsonConvert.DeserializeObject(data)
      
              ' Print the number of hits
              Console.WriteLine(search_response("hits"))
      
              ' Print results
              For Each result In search_response("results")
                  ' Print matched brand
                  Console.WriteLine(result("item")("name"))
              Next
          End Sub
      
          ' -- your API key -- (https:'octopart.com/api/register)
          Private Const APIKEY As String = "REPLACE_ME"
      End Module
      

      Download examples/brands_search.vb »
  • HTTP Responses

    These are some common HTTP responses and their likely causes:

    • 200 OK: The request was fetched successfuly
    • 400 Bad Request: The request failed validation

• GET /brands/get_multi - Fetch multiple brands
  • Description

    This endpoint returns multiple brands simultaneously by primary key. The fetch key for each brand is its 'uid'.

    URL Arguments

    Argument	Datatype	Default
    uid[]	string	None

    • uid[]
      The uid for an individual brand. Append multiple url arguments to fetch multiple brands (up to 20).

    See Universal URL Arguments.

    Response Object

    This method returns a JSON object mapping uids to <Brand objects>.

  • Examples
    • Python

      import json
      import urllib
      
      url = 'http://octopart.com/api/v3/brands/get_multi'
      url += "?apikey=REPLACE_ME"
      
      args = [
         ('uid[]', '2239e3330e2df5fe'),
         ('uid[]', 'c4f105fbe7591336')
         ]
      
      url += "&" + urllib.urlencode(args)
      
      data = urllib.urlopen(url).read()
      server_response = json.loads(data)
      
      # print brand display names
      for (uid, brand) in server_response.items():
         print brand['name']
      

      Download examples/brands_get_multi.py »
    • Ruby

      require 'rubygems'
      require 'json'
      require 'net/http'
      
      url = "http://octopart.com/api/v3/brands/get_multi"
      url += "?apikey=REPLACE_ME"
      
      uids = [
              "2239e3330e2df5fe",
              "c4f105fbe7591336"
             ]
      
      urlargs = []
      uids.each do |uid|
        urlargs.push("uid[]=" + uid)
      end
      
      url += "&" + urlargs.join("&")
      
      resp = Net::HTTP.get_response(URI.parse(url))
      server_response = JSON.parse(resp.body)
      
      # print names
      server_response.keys.each do |key|
        puts server_response[key]['name']
      end
      

      Download examples/brands_get_multi.rb »
    • JavaScript

      <script src="http://code.jquery.com/jquery-1.11.0.js"></script>
      <script>
          var url = "http://octopart.com/api/v3/brands/get_multi";
          url += "?apikey=REPLACE_ME";
          url += "&callback=?";
      
          var args = {
              uid: [
                  "2239e3330e2df5fe",
                  "c4f105fbe7591336"
              ]
          };
      
          $.getJSON(url, args, function(brand) {
              // iterate through brands
              $.each(brands, function(uid, brand){
                  // print matched brand items
                  console.log(brand['name']);
              });
          });
      </script>
      

      Download examples/brands_get_multi.html »
    • C Sharp

      namespace OctopartApi
      {
          using Newtonsoft.Json;
          using RestSharp;
          using System;
      
          public static class BrandsGetMulti
          {
              public static void ExecuteSearch()
              {
                  // -- your search query --
                  string id1 = "2239e3330e2df5fe";
                  string id2 = "c4f105fbe7591336";
      
                  string octopartUrlBase = "http://octopart.com/api/v3";
                  string octopartUrlEntpoint = "brands/get_multi";
                  string apiKey = APIKEY;
      
                  // Create the search request
                  var client = new RestClient(octopartUrlBase);
                  var req = new RestRequest(octopartUrlEntpoint, Method.GET)
                              .AddParameter("apikey", apiKey)
                              .AddParameter("uid[]", id1)
                              .AddParameter("uid[]", id2);
      
                  // Perform the search and obtain results
                  var data = client.Execute(req).Content;
                  var server_response = JsonConvert.DeserializeObject<dynamic>(data);
      
                  // Print the brand display names
                  foreach (var uid in server_response)
                  {
                      Console.WriteLine(uid.Value["name"]);
                  }
              }
      
              // -- your API key -- (https://octopart.com/api/register)
              private const string APIKEY = "REPLACE_ME";
          }
      }
      

      Download examples/brands_get_multi.cs »
    • VB.NET

      Imports Newtonsoft.Json
      Imports RestSharp
      Imports System
      
      Public Module BrandsGetMulti
          Public Sub ExecuteSearch()
              ' -- your search query --
              Dim id1 As String = "2239e3330e2df5fe"
              Dim id2 As String = "c4f105fbe7591336"
      
              Dim octopartUrlBase As String = "http://octopart.com/api/v3"
              Dim octopartUrlEntpoint As String = "brands/get_multi"
              Dim apiKey As String = BrandsGetMulti.APIKEY
      
              ' Create the search request
              Dim client = New RestClient(octopartUrlBase)
              Dim req = New RestRequest(octopartUrlEntpoint, Method.GET) _
                              .AddParameter("apikey", apiKey) _
                              .AddParameter("uid[]", id1) _
                              .AddParameter("uid[]", id2)
      
              ' Perform the search and obtain results
              Dim data = client.Execute(req).Content
              Dim server_response = JsonConvert.DeserializeObject(data)
      
              ' Print the brand display names
              For Each uid In server_response
                  Console.WriteLine(uid.Value.GetValue("name"))
              Next
          End Sub
      
          ' -- your API key -- (https:'octopart.com/api/register)
          Private Const APIKEY As String = "REPLACE_ME"
      End Module
      

      Download examples/brands_get_multi.vb »
  • HTTP Responses

    These are some common HTTP responses and their likely causes:

    • 200 OK: The request was completed successfuly

/categories

• GET /categories/{uid} - Fetch a category by its primary key
  • Description

    This method returns invividual category nodes by primary key. The fetch key for a category is its 'uid'.

    URL Arguments

    See Universal URL Arguments.

    Response Object

    This method returns a <Category object>

  • Examples
    • Python

      import json
      import urllib
      
      url = 'http://octopart.com/api/v3/categories/87a44aaeb6be5c63'
      url += "?apikey=REPLACE_ME"
      
      data = urllib.urlopen(url).read()
      category = json.loads(data)
      
      # print name
      print category['name']
      

      Download examples/categories_get.py »
    • Ruby

      require 'rubygems'
      require 'json'
      require 'net/http'
      
      url = "http://octopart.com/api/v3/categories/87a44aaeb6be5c63"
      url += "?apikey=REPLACE_ME"
      
      resp = Net::HTTP.get_response(URI.parse(url))
      category = JSON.parse(resp.body)
      
      # print name
      puts category['name']
      

      Download examples/categories_get.rb »
    • JavaScript

      <script src="http://code.jquery.com/jquery-1.11.0.js"></script>
      <script>
          var url = "http://octopart.com/api/v3/categories/87a44aaeb6be5c63";
          url += "?apikey=REPLACE_ME";
          url += "&callback=?";
      
          $.getJSON(url, function(category) {
              // print name
              console.log(category['name']);
          });
      </script>
      

      Download examples/categories_get.html »
    • C Sharp

      namespace OctopartApi
      {
          using Newtonsoft.Json;
          using RestSharp;
          using System;
      
          public static class CategoriesGet
          {
              public static void ExecuteSearch()
              {
                  // -- your search query --
                  string id = "87a44aaeb6be5c63";
      
                  string octopartUrlBase = "http://octopart.com/api/v3";
                  string octopartUrlEndpoint = "categories/{id}";
                  string apiKey = APIKEY;
      
                  // Create the search request
                  var client = new RestClient(octopartUrlBase);
                  var req = new RestRequest(octopartUrlEndpoint, Method.GET)
                              .AddParameter("apikey", apiKey)
                              .AddUrlSegment("id", id);
      
                  // Perform the search and obtain results
                  var data = client.Execute(req).Content;
                  var category = JsonConvert.DeserializeObject<dynamic>(data);
      
                  // Print name
                  Console.WriteLine(category["name"]);
              }
      
              // -- your API key -- (https://octopart.com/api/register)
              private const string APIKEY = "REPLACE_ME";
          }
      }
      

      Download examples/categories_get.cs »
    • VB.NET

      Imports Newtonsoft.Json
      Imports RestSharp
      Imports System
      
      Public Module CategoriesGet
          Public Sub ExecuteSearch()
              ' -- your search query --
              Dim id As String = "87a44aaeb6be5c63"
      
              Dim octopartUrlBase As String = "http://octopart.com/api/v3"
              Dim octopartUrlEndpoint As String = "categories/{id}"
              Dim apiKey As String = CategoriesGet.APIKEY
      
              ' Create the search request
              Dim client = New RestClient(octopartUrlBase)
              Dim req = New RestRequest(octopartUrlEndpoint, Method.GET) _
                              .AddParameter("apikey", apiKey) _
                              .AddUrlSegment("id", id)
      
              ' Perform the search and obtain results
              Dim data = client.Execute(req).Content
              Dim category = JsonConvert.DeserializeObject(data)
      
              ' Print name
              Console.WriteLine(category("name"))
          End Sub
      
          ' -- your API key -- (https:'octopart.com/api/register)
          Private Const APIKEY As String = "REPLACE_ME"
      End Module
      

      Download examples/categories_get.vb »
  • HTTP Responses

    These are some common HTTP responses and their likely causes:

    • 200 OK: Category was fetched successfuly
    • 404 Not Found: The category does not exist

• GET /categories/search - Search across categories
  • Description

    This method allows searching across categories by keyword.

    URL Arguments

    Argument	Datatype	Default
    q	string	""
    start	integer	0
    limit	integer	10
    sortby	string	"score desc"
    filter[fields][<fieldname>][]	string	""
    filter[queries][]	string	""
    facet[fields][<fieldname>][include]	boolean	false
    facet[fields][<fieldname>][exclude_filter]	boolean	false
    facet[fields][<fieldname>][start]	integer	0
    facet[fields][<fieldname>][limit]	integer	10
    facet[queries][]	string	""
    stats[<fieldname>][include]	boolean	false
    stats[<fieldname>][exclude_filter]	boolean	false

    • q
      Full-text query string
    • start
      Ordinal position of first result. First position is 0. Maximum is 1000.
    • limit
      Maximum number of results to return. Default is 10. Maximum is 100.
    • sortby
      Comma separated list of (fieldname, fieldorder) pairs
    • filter[fields][<fieldname>][]
      Attribute (fieldname/fieldvalue) pair to filter results on
    • filter[queries][]
      Arbitrary filter query string
    • facet[fields][<fieldname>][include]
      If specified, perform faceting on given <fieldname>
    • facet[fields][<fieldname>][exclude_filter]
      If specified, remove <fieldname> from filters when calculating facets for <fieldname>
    • facet[fields][<fieldname>][start]
      Ordinal position of first facet to return. First position is 0. Maximum is 1000.
    • facet[fields][<fieldname>][limit]
      Number of facets to return. Default is 10. Maximum is 100.
    • facet[queries][]
      Arbitrary filter query string to facet on
    • stats[<fieldname>][include]
      If specified, calculate statistics for <fieldname
    • stats[<fieldname>][exclude_filter]
      If specified, remove <fieldname> from filters when calculating statistics for <fieldname>

    See Universal URL Arguments.

    Searchable Fields

    Fieldname	Description
    name	Category node name
    parent_uid	Category node parent uid
    ancestor_uids	Category node ancestor uid's

    Response Object

    This method returns a <SearchResponse object>.

  • Examples
    • Python

      import json
      import urllib
      
      url = "http://octopart.com/api/v3/categories/search"
      url += "?apikey=REPLACE_ME"
      
      args = [
         ('q', 'semiconductors'),
         ('start', 0),
         ('limit', 10)
         ]
      
      url += '&' + urllib.urlencode(args)
      
      data = urllib.urlopen(url).read()
      search_response = json.loads(data)
      
      # print number of hits
      print search_response['hits']
      
      # print results
      for result in search_response['results']:
         # print matched category
         print result['item']['name']
      

      Download examples/categories_search.py »
    • Ruby

      require 'rubygems'
      require 'json'
      require 'net/http'
      
      url = "http://octopart.com/api/v3/categories/search"
      url += "?apikey=REPLACE_ME"
      
      def to_query(hsh)
        hsh.map {|k, v| "#{k}=#{URI.encode(v.to_s)}"}.join("&")
      end
      
      params = {
        :q => "semiconductors",
        :start => 0,
        :limit => 10
      }
      
      url += "&" + to_query(params)
      
      resp = Net::HTTP.get_response(URI.parse(url))
      search_response = JSON.parse(resp.body)
      
      # print number of hits
      puts search_response['hits']
      
      # print results
      search_response['results'].each do |result|
        # print matched category
        puts result['item']['name']
      end
      

      Download examples/categories_search.rb »
    • JavaScript

      <script src="http://code.jquery.com/jquery-1.11.0.js"></script>
      <script>
          var url = "http://octopart.com/api/v3/categories/search";
          url += "?apikey=REPLACE_ME";
          url += "&callback=?";
      
          var args = {
              q: "semiconductors",
              start: 0,
              limit: 10
          };
      
          $.getJSON(url, args, function(search_response) {
              // print original request
              console.log(search_response['request']);
      
              // iterate through results
              $.each(search_response['results'], function(i, result){
                  // print matched category items
                  console.log(result['item']['name']);
              });
          });
      </script>
      

      Download examples/categories_search.html »
    • C Sharp

      namespace OctopartApi
      {
          using Newtonsoft.Json;
          using RestSharp;
          using System;
      
          public static class CategoriesSearch
          {
              public static void ExecuteSearch()
              {
                  // -- your search query --
                  string query = "semiconductors";
      
                  string octopartUrlBase = "http://octopart.com/api/v3";
                  string octopartUrlEndpoint = "categories/search";
                  string apiKey = APIKEY;
      
                  // Create the search request
                  var client = new RestClient(octopartUrlBase);
                  var req = new RestRequest(octopartUrlEndpoint, Method.GET)
                              .AddParameter("apikey", apiKey)
                              .AddParameter("q", query)
                              .AddParameter("start", "0")
                              .AddParameter("limit", "10");
      
                  // Perform the search and obtain results
                  var data = client.Execute(req).Content;
                  var search_response = JsonConvert.DeserializeObject<dynamic>(data);
      
                  // Print the number of hits
                  Console.WriteLine(search_response["hits"]);
      
                  // Print results
                  foreach (var result in search_response["results"])
                  {
                      // Print matched category
                      Console.WriteLine(result["item"]["name"]);
                  }
              }
      
              // -- your API key -- (https://octopart.com/api/register)
              private const string APIKEY = "REPLACE_ME";
          }
      }
      

      Download examples/categories_search.cs »
    • VB.NET

      Imports Newtonsoft.Json
      Imports RestSharp
      Imports System
      
      Public Module CategoriesSearch
          Public Sub ExecuteSearch()
              ' -- your search query --
              Dim query As String = "semiconductors"
      
              Dim octopartUrlBase As String = "http://octopart.com/api/v3"
              Dim octopartUrlEndpoint As String = "categories/search"
              Dim apiKey As String = CategoriesSearch.APIKEY
      
              ' Create the search request
              Dim client = New RestClient(octopartUrlBase)
              Dim req = New RestRequest(octopartUrlEndpoint, Method.GET) _
                              .AddParameter("apikey", apiKey) _
                              .AddParameter("q", query) _
                              .AddParameter("start", "0") _
                              .AddParameter("limit", "10")
      
              ' Perform the search and obtain results
              Dim data = client.Execute(req).Content
              Dim search_response = JsonConvert.DeserializeObject(data)
      
              ' Print the number of hits
              Console.WriteLine(search_response("hits"))
      
              ' Print results
              For Each result In search_response("results")
                  ' Print matched category
                  Console.WriteLine(result("item")("name"))
              Next
          End Sub
      
          ' -- your API key -- (https:'octopart.com/api/register)
          Private Const APIKEY As String = "REPLACE_ME"
      End Module
      

      Download examples/categories_search.vb »
  • HTTP Responses

    These are some common HTTP responses and their likely causes:

    • 200 OK: The request was completed successfuly
    • 400 Bad Request: The request failed validation

• GET /categories/get_multi - Fetch multiple categories simultaneously
  • Description

    This endpoint returns multiple categories simultaneously by primary key. The fetch key for each part is its 'uid'. Missing categories will also be missing from the response list.

    URL Arguments

    Argument	Datatype	Default
    uid[]	string	None

    • uid[]
      The uid for an individual part. Append multiple url arguments to fetch multiple categories (up to 20).

    See Universal URL Arguments.

    Response Object

    This method returns a JSON object mapping uids to <Part objects>.

  • Examples
    • Python

      import json
      import urllib
      
      url = 'http://octopart.com/api/v3/categories/get_multi'
      url += "?apikey=REPLACE_ME"
      
      args = [
         ('uid[]', '3b27f62d0a3ae0e0'),
         ('uid[]', '9e07530daf1645c0')
         ]
      
      url += "&" + urllib.urlencode(args)
      
      data = urllib.urlopen(url).read()
      server_response = json.loads(data)
      
      # print category display names
      for (uid, category) in server_response.items():
         print category['name']
      

      Download examples/categories_get_multi.py »
    • Ruby

      require 'rubygems'
      require 'json'
      require 'net/http'
      
      url = "http://octopart.com/api/v3/categories/get_multi"
      url += "?apikey=REPLACE_ME"
      
      uids = [
              "3b27f62d0a3ae0e0",
              "9e07530daf1645c0"
             ]
      
      urlargs = []
      uids.each do |uid|
        urlargs.push("uid[]=" + uid)
      end
      
      url += "&" + urlargs.join("&")
      
      resp = Net::HTTP.get_response(URI.parse(url))
      server_response = JSON.parse(resp.body)
      
      # print names
      server_response.keys.each do |key|
        puts server_response[key]['name']
      end
      

      Download examples/categories_get_multi.rb »
    • JavaScript

      <script src="http://code.jquery.com/jquery-1.11.0.js"></script>
      <script>
          var url = "http://octopart.com/api/v3/categories/get_multi";
          url += "?apikey=REPLACE_ME";
          url += "&callback=?";
      
          var args = {
              uid: [
                  "3b27f62d0a3ae0e0",
                  "9e07530daf1645c0"
              ]
          };
      
          $.getJSON(url, args, function(brand) {
              // iterate through categories
              $.each(categories, function(uid, category){
                  // print matched category items
                  console.log(category['name']);
              });
          });
      </script>
      

      Download examples/categories_get_multi.html »
    • C Sharp

      namespace OctopartApi
      {
          using Newtonsoft.Json;
          using RestSharp;
          using System;
      
          public static class CategoriesGetMulti
          {
              public static void ExecuteSearch()
              {
                  // -- your search query --
                  string id1 = "3b27f62d0a3ae0e0";
                  string id2 = "9e07530daf1645c0";
      
                  string octopartUrlBase = "http://octopart.com/api/v3";
                  string octopartUrlEndpoint = "categories/get_multi";
                  string apiKey = APIKEY;
      
                  // Create the search request
                  var client = new RestClient(octopartUrlBase);
                  var req = new RestRequest(octopartUrlEndpoint, Method.GET)
                              .AddParameter("apikey", apiKey)
                              .AddParameter("uid[]", id1)
                              .AddParameter("uid[]", id2);
      
                  // Perform the search and obtain results
                  var data = client.Execute(req).Content;
                  var server_response = JsonConvert.DeserializeObject<dynamic>(data);
      
                  // Print the category display names
                  foreach (var uid in server_response)
                  {
                      Console.WriteLine(uid.Value["name"]);
                  }
              }
      
              // -- your API key -- (https://octopart.com/api/register)
              private const string APIKEY = "REPLACE_ME";
          }
      }
      

      Download examples/categories_get_multi.cs »
    • VB.NET

      Imports Newtonsoft.Json
      Imports RestSharp
      Imports System
      
      Public Module CategoriesGetMulti
          Public Sub ExecuteSearch()
              ' -- your search query --
              Dim id1 As String = "3b27f62d0a3ae0e0"
              Dim id2 As String = "9e07530daf1645c0"
      
              Dim octopartUrlBase As String = "http://octopart.com/api/v3"
              Dim octopartUrlEndpoint As String = "categories/get_multi"
              Dim apiKey As String = CategoriesGetMulti.APIKEY
      
              ' Create the search request
              Dim client = New RestClient(octopartUrlBase)
              Dim req = New RestRequest(octopartUrlEndpoint, Method.GET) _
                              .AddParameter("apikey", apiKey) _
                              .AddParameter("uid[]", id1) _
                              .AddParameter("uid[]", id2)
      
              ' Perform the search and obtain results
              Dim data = client.Execute(req).Content
              Dim server_response = JsonConvert.DeserializeObject(data)
      
              ' Print the category display names
              For Each uid In server_response
                  Console.WriteLine(uid.Value.GetValue("name"))
              Next
          End Sub
      
          ' -- your API key -- (https:'octopart.com/api/register)
          Private Const APIKEY As String = "REPLACE_ME"
      End Module
      

      Download examples/categories_get_multi.vb »
  • HTTP Responses

    These are some common HTTP responses and their likely causes:

    • 200 OK: Request was completed successfuly

/parts

• GET /parts/{uid} - Fetch a part by its primary key
  • Description

    This method returns individual parts by primary key. The fetch key for a part is its 'uid'.

    URL Arguments

    See Universal URL Arguments.

    Response Object

    This method returns a <Part object>.

  • Examples
    • Python

      import json
      import urllib
      
      url = 'http://octopart.com/api/v3/parts/103cdb613d20cffb'
      url += '?apikey=REPLACE_ME'
      
      data = urllib.urlopen(url).read()
      response = json.loads(data)
      
      # print brand, mpn
      print response['brand']['name']
      print response['mpn']
      
      # print offers
      for offer in response['offers']:
          print offer['seller']['name']
          print offer['sku']
      

      Download examples/parts_get.py »
    • Ruby

      require 'rubygems'
      require 'json'
      require 'net/http'
      
      url = "http://octopart.com/api/v3/parts/103cdb613d20cffb"
      url += '?apikey=REPLACE_ME'
      
      resp = Net::HTTP.get_response(URI.parse(url))
      part = JSON.parse(resp.body)
      
      # print brand, mpn
      puts part['brand']['name']
      puts part['mpn']
      
      # print offers
      part['offers'].each do |offer|
        puts offer['seller']['name']
        puts offer['sku']
      end
      

      Download examples/parts_get.rb »
    • JavaScript

      <script src="http://code.jquery.com/jquery-1.11.0.js"></script>
      <script>
          var url = "http://octopart.com/api/v3/parts/103cdb613d20cffb";
          url += "?apikey=REPLACE_ME";
          url += "&callback=?";
      
          $.getJSON(url, function(response) {
              // print brand, mpn
              console.log(response['brand']['name']);
              console.log(response['mpn']);
      
              // print offers
              $.each(response['offers'], function(i, offer) {
                  console.log(offer['seller']['name']);
                  console.log(offer['sku']);
              });
          });
      </script>
      

      Download examples/parts_get.html »
    • C Sharp

      namespace OctopartApi
      {
          using Newtonsoft.Json;
          using RestSharp;
          using System;
      
          public static class PartsGet
          {
              public static void ExecuteSearch()
              {
                  // -- your search query --
                  string id = "103cdb613d20cffb";
      
                  string octopartUrlBase = "http://octopart.com/api/v3";
                  string octopartUrlEndpoint = "parts/{id}";
                  string apiKey = APIKEY;
      
                  // Create the search request
                  var client = new RestClient(octopartUrlBase);
                  var req = new RestRequest(octopartUrlEndpoint, Method.GET)
                              .AddParameter("apikey", apiKey)
                              .AddUrlSegment("id", id);
      
                  // Perform the search and obtain results
                  var data = client.Execute(req).Content;
                  var response = JsonConvert.DeserializeObject<dynamic>(data);
      
                  // Print brand, mpn
                  Console.WriteLine(response["brand"]["name"]);
                  Console.WriteLine(response["mpn"]);
      
                  // Print offers
                  foreach (var offer in response["offers"])
                  {
                      Console.WriteLine(offer["seller"]["name"]);
                      Console.WriteLine(offer["sku"]);
                  }
              }
      
              // -- your API key -- (https://octopart.com/api/register)
              private const string APIKEY = "REPLACE_ME";
          }
      }
      

      Download examples/parts_get.cs »
    • VB.NET

      Imports Newtonsoft.Json
      Imports RestSharp
      Imports System
      
      Public Module PartsGet
          Public Sub ExecuteSearch()
              ' -- your search query --
              Dim id As String = "103cdb613d20cffb"
      
              Dim octopartUrlBase As String = "http://octopart.com/api/v3"
              Dim octopartUrlEndpoint As String = "parts/{id}"
              Dim apiKey As String = PartsGet.APIKEY
      
              ' Create the search request
              Dim client = New RestClient(octopartUrlBase)
              Dim req = New RestRequest(octopartUrlEndpoint, Method.GET) _
                              .AddParameter("apikey", apiKey) _
                              .AddUrlSegment("id", id)
      
              ' Perform the search and obtain results
              Dim data = client.Execute(req).Content
              Dim response = JsonConvert.DeserializeObject(data)
      
              ' Print brand, mpn
              Console.WriteLine(response("brand")("name"))
              Console.WriteLine(response("mpn"))
      
              ' Print offers
              For Each offer In response("offers")
                  Console.WriteLine(offer("seller")("name"))
                  Console.WriteLine(offer("sku"))
              Next
          End Sub
      
          ' -- your API key -- (https:'octopart.com/api/register)
          Private Const APIKEY As String = "REPLACE_ME"
      End Module
      

      Download examples/parts_get.vb »
  • HTTP Responses

    These are some common HTTP responses and their likely causes:

    • 200 OK: Part was fetched successfuly
    • 404 Not Found: The part does not exist

• GET /parts/match - Match a list of parts by MPN or SKU
  • Description

    This method returns parts matched by MPN/SKU filter. It also accepts brand and seller filters as well. This is the ideal method to match a list of parts (e.g. a BOM) to the Octopart parts database.

    URL Arguments

    Argument	Datatype	Default
    queries	string	"[]"
    exact_only	boolean	false

    • queries
      JSON encoded list of PartsMatchQuery objects. Maximum value of 'limit' argument is 20, and maximum 'start' + 'limit' is 100.
    • exact_only
      If specified, match non-alphanumeric characters in MPNs and SKUs

    See Universal URL Arguments.

    Response Object

    This method returns a <PartsMatchResponse object>.

  • Examples
    • Python

      import json
      import urllib
      
      queries = [
          {'mpn': 'SN74S74N',
           'reference': 'line1'},
          {'sku': '67K1122',
           'reference': 'line2'},
          {'mpn_or_sku': 'SN74S74N',
           'reference': 'line3'},
          {'brand': 'Texas Instruments',
           'mpn': 'SN74S74N',
           'reference': 'line4'}
          ]
      
      url = 'http://octopart.com/api/v3/parts/match?queries=%s' \
          % urllib.quote(json.dumps(queries))
      url += '&apikey=REPLACE_ME'
      
      data = urllib.urlopen(url).read()
      response = json.loads(data)
      
      # print request time (in milliseconds)
      print response['msec']
      
      # print mpn's
      for result in response['results']:
          print "Reference: %s" % result['reference']
          for item in result['items']:
              print item['mpn']
      

      Download examples/parts_match.py »
    • Ruby

      require 'rubygems'
      require 'json'
      require 'net/http'
      
      url = "http://octopart.com/api/v3/parts/match"
      url += "?apikey=REPLACE_ME"
      
      queries = [
                 {:mpn => "SN74S74N", :reference => "line1"},
                 {:sku => "67K1122", :reference => "line2"},
                 {:mpn_or_sku => "SN74S74N", :reference =>"line3"},
                 {:brand => "Texas Instruments", :mpn => "SN74S74N",
                   :reference => "line4"}
                ]
      
      url += "&queries=" + URI.encode(JSON.generate(queries))
      
      resp = Net::HTTP.get_response(URI.parse(url))
      server_response = JSON.parse(resp.body)
      
      # print request time (in milliseconds)
      puts server_response['msec']
      
      # print mpn's
      server_response['results'].each do |result|
        puts "Reference: " + result['reference']
        result['items'].each do |part|
          puts part['mpn']
        end
      end
      

      Download examples/parts_match.rb »
    • JavaScript

      <script src="http://code.jquery.com/jquery-1.11.0.js"></script>
      <script src="http://ajax.cdnjs.com/ajax/libs/json2/20110223/json2.js"></script>
      <script>
          var url = "http://octopart.com/api/v3/parts/match";
          url += "?apikey=REPLACE_ME";
          url += "&callback=?";
      
          var queries = [
              {'mpn': 'SN74S74N', 'reference': 'line1'},         
              {'sku': '67K1122', 'reference': 'line2'},         
              {'mpn_or_sku': 'SN74S74N', 'reference': 'line3'},         
              {'mpn': 'SN74S74N', 'brand': 'Texas Instruments', 'reference': 'line4'}
          ]; 
      
          var args = {
              queries: JSON.stringify(queries)
          };
      
          $.getJSON(url, args, function(response){
              var queries = response['request']['queries'];
              $.each(queries, function(i, query) {
                  // print query
                  console.log(query);
                  
                  // print corresponding result
                  console.log(response['results'][i]);
              });
          });
      </script>
      

      Download examples/parts_match.html »
    • C Sharp

      namespace OctopartApi
      {
          using Newtonsoft.Json;
          using RestSharp;
          using System;
          using System.Collections.Generic;
          using System.Web.Script.Serialization;
      
          public static class PartsMatch
          {
              public static void ExecuteSearch()
              {
                  // -- your search query --
                  var query = new List<dynamic>()
                  {
                      new Dictionary<string, string>()
                      { { "mpn", "SN74S74N" },
                        { "reference", "line1" } },
                      new Dictionary<string, string>()
                      { { "sku", "67K1122" },
                        { "reference", "line2" } },
                      new Dictionary<string, string>()
                      { { "mpn_or_sku", "SN74S74N" },
                        { "reference", "line3" } },
                      new Dictionary<string, string>()
                      { { "brand", "Texas Instruments" },
                        { "mpn", "SN74S74N" },
                        { "reference", "line4" } }
                  };
      
                  string octopartUrlBase = "http://octopart.com/api/v3";
                  string octopartUrlEndpoint = "parts/match";
                  string apiKey = APIKEY;
      
                  // Create the search request
                  string queryString = (new JavaScriptSerializer()).Serialize(query);
                  var client = new RestClient(octopartUrlBase);
                  var req = new RestRequest(octopartUrlEndpoint, Method.GET)
                              .AddParameter("apikey", apiKey)
                              .AddParameter("queries", queryString);
      
                  // Perform the search and obtain results
                  var data = client.Execute(req).Content;
                  var response = JsonConvert.DeserializeObject<dynamic>(data);
      
                  // Print request time (in milliseconds)
                  Console.WriteLine(response["msec"]);
      
                  // Print mpn's
                  foreach (var result in response["results"])
                  {
                      Console.WriteLine("Reference: " + result["reference"]);
                      foreach (var item in result["items"])
                      {
                          Console.WriteLine(item["mpn"]);
                      }
                  }
              }
      
              // -- your API key -- (https://octopart.com/api/register)
              private const string APIKEY = "REPLACE_ME";
          }
      }
      

      Download examples/parts_match.cs »
    • VB.NET

      Imports Newtonsoft.Json
      Imports RestSharp
      Imports System
      Imports System.Collections.Generic
      Imports System.Web.Script.Serialization
      
      Public Module PartsMatch
          Public Sub ExecuteSearch()
              ' -- your search query --
              Dim query = New List(Of Dictionary(Of String, String))() From _
              { _
                  New Dictionary(Of String, String)() From _
                  {{"mpn", "SN74S74N"}, _
                      {"reference", "line1"}}, _
                  New Dictionary(Of String, String)() From _
                  {{"sku", "67K1122"}, _
                      {"reference", "line2"}}, _
                  New Dictionary(Of String, String)() From _
                  {{"mpn_or_sku", "SN74S74N"}, _
                      {"reference", "line3"}}, _
                  New Dictionary(Of String, String)() From _
                  {{"brand", "Texas Instruments"}, _
                      {"mpn", "SN74S74N"}, _
                      {"reference", "line4"}} _
              }
      
              Dim octopartUrlBase As String = "http://octopart.com/api/v3"
              Dim octopartUrlEndpoint As String = "parts/match"
              Dim apiKey As String = PartsMatch.APIKEY
      
              ' Create the search request
              Dim queryString = (New JavaScriptSerializer()).Serialize(query)
              Dim client = New RestClient(octopartUrlBase)
              Dim req = New RestRequest(octopartUrlEndpoint, Method.GET) _
                              .AddParameter("apikey", apiKey) _
                              .AddParameter("queries", queryString)
      
              ' Perform the search and obtain results
              Dim data = client.Execute(req).Content
              Dim response = JsonConvert.DeserializeObject(data)
      
              ' Print request time (in milliseconds)
              Console.WriteLine(response("msec"))
      
              ' Print mpn's
              For Each result In response("results")
                  Console.WriteLine("Reference: " & result("reference"))
                  For Each item In result("items")
                      Console.WriteLine(item("mpn"))
                  Next
              Next
          End Sub
      
          ' -- your API key -- (https:'octopart.com/api/register)
          Private Const APIKEY As String = "REPLACE_ME"
      End Module
      

      Download examples/parts_match.vb »
  • HTTP Responses

    These are some common HTTP responses and their likely causes:

    • 200 OK: Request was completed successfuly
    • 400 Bad Request: JSON parsing error

• GET /parts/search - Search across parts
  • Description

    This method allows searching across parts by keyword. or technical specs. This is the ideal method to use to filter parts by manufacturer or to perform a parametric search.

    URL Arguments

    Argument	Datatype	Default
    q	string	""
    start	integer	0
    limit	integer	10
    sortby	string	"score desc"
    filter[fields][<fieldname>][]	string	""
    filter[queries][]	string	""
    facet[fields][<fieldname>][include]	boolean	false
    facet[fields][<fieldname>][exclude_filter]	boolean	false
    facet[fields][<fieldname>][start]	integer	0
    facet[fields][<fieldname>][limit]	integer	10
    facet[queries][]	string	""
    stats[<fieldname>][include]	boolean	false
    stats[<fieldname>][exclude_filter]	boolean	false
    spec_drilldown[include]	boolean	false
    spec_drilldown[exclude_filter]	boolean	false
    spec_drilldown[limit]	integer	10

    • q
      Full-text query string
    • start
      Ordinal position of first result. First position is 0. Maximum is 1000.
    • limit
      Maximum number of results to return. Default is 10. Maximum is 100.
    • sortby
      Comma separated list of (fieldname, fieldorder) pairs
    • filter[fields][<fieldname>][]
      Attribute (fieldname/fieldvalue) pair to filter results on
    • filter[queries][]
      Arbitrary filter query string
    • facet[fields][<fieldname>][include]
      If specified, perform faceting on given <fieldname>
    • facet[fields][<fieldname>][exclude_filter]
      If specified, remove <fieldname> from filters when calculating facets for <fieldname>
    • facet[fields][<fieldname>][start]
      Ordinal position of first facet to return. First position is 0. Maximum is 1000.
    • facet[fields][<fieldname>][limit]
      Number of facets to return. Default is 10. Maximum is 100.
    • facet[queries][]
      Arbitrary filter query string to facet on
    • stats[<fieldname>][include]
      If specified, calculate statistics for <fieldname
    • stats[<fieldname>][exclude_filter]
      If specified, remove <fieldname> from filters when calculating statistics for <fieldname>
    • spec_drilldown[include]
      If specified, perform drilldown
    • spec_drilldown[exclude_filter]
      If specified, remove <fieldname> from filters when calculating statistics for <fieldname>
    • spec_drilldown[limit]
      Number of facets to return for each field. Default is 10. Maximum is 100.

    See Universal URL Arguments.

    Searchable Fields

    Fieldname	Description
    mpn	Manufacturer part number
    brand.name	Manufacturer brand name
    offers.sku	Distributor SKU
    offers.seller.name	Distributor name
    descriptions.value	Description text value
    specs.*.value	Technical specs value property
    specs.*.min_value	Technical specs min_value property
    specs.*.max_value	Technical specs max_value property
    category_uids	Category uid's

    Response Object

    This method returns a <SearchResponse object>.

  • Examples
    • Python

      import json
      import urllib
      
      url = "http://octopart.com/api/v3/parts/search"
      
      # NOTE: Use your API key here (https://octopart.com/api/register)
      url += "?apikey=REPLACE_ME" 
      
      args = [
         ('q', 'solid state relay'),
         ('start', 0),
         ('limit', 10)
         ]
      
      url += '&' + urllib.urlencode(args)
      
      data = urllib.urlopen(url).read()
      search_response = json.loads(data)
      
      # print number of hits
      print search_response['hits']
      
      # print results
      for result in search_response['results']:
         part = result['item']
      
         # print matched part
         print "%s - %s" % (part['brand']['name'], part['mpn'])
      

      Download examples/parts_search.py »
    • Ruby

      require 'rubygems'
      require 'json'
      require 'net/http'
      
      url = "http://octopart.com/api/v3/parts/search"
      
      # NOTE: Use your API key here (https://octopart.com/api/register)
      url += "?apikey=REPLACE_ME"
      
      def to_query(hsh)
        hsh.map {|k, v| "#{k}=#{URI.encode(v.to_s)}"}.join("&")
      end
      
      params = {
        :q =>"solid state relay",
        :start => 0,
        :limit => 10
      }
      
      url += "&" + to_query(params)
      
      resp = Net::HTTP.get_response(URI.parse(url))
      search_response = JSON.parse(resp.body)
      
      # print number of hits
      puts search_response['hits']
      
      # print results
      search_response['results'].each do |result|
        part = result['item']
      
        # print matched part
        puts part['brand']['name'] + ' - ' + part['mpn']
      end
      

      Download examples/parts_search.rb »
    • JavaScript

      <script src="http://code.jquery.com/jquery-1.11.0.js"></script>
      <script>
          var url = "http://octopart.com/api/v3/parts/search";
          url += "?callback=?";
      
          // NOTE: Use your API key here (https://octopart.com/api/register)
          url += "&apikey=REPLACE_ME";
      
          var args = {
              q: "solid state relay",
              start: 0,
              limit: 10
          };
      
          $.getJSON(url, args, function(search_response) {
              // print original request
              console.log(search_response['request']);
      
              // iterate through results
              $.each(search_response['results'], function(i, result){
                  var part = result['item'];
      
                  // print matched part items
                  console.log(part['brand']['name'] + ' - ' + part['mpn']);
              });
          });
      </script>
      

      Download examples/parts_search.html »
    • C Sharp

      namespace OctopartApi
      {
          using Newtonsoft.Json;
          using RestSharp;
          using System;
      
          public static class PartsSearch
          {
              public static void ExecuteSearch()
              {
                  // -- your search query --
                  string query = "solid state relay";
      
                  string octopartUrlBase = "http://octopart.com/api/v3";
                  string octopartUrlEndpoint = "parts/search";
                  string apiKey = APIKEY;
      
                  // Create the search request
                  var client = new RestClient(octopartUrlBase);
                  var req = new RestRequest(octopartUrlEndpoint, Method.GET)
                              .AddParameter("apikey", apiKey)
                              .AddParameter("q", query)
                              .AddParameter("start", "0")
                              .AddParameter("limit", "10");
      
                  // Perform the search and obtain results
                  var data = client.Execute(req).Content;
                  var search_response = JsonConvert.DeserializeObject<dynamic>(data);
      
                  // Print number of hits
                  Console.WriteLine(search_response["hits"]);
      
                  // Print results
                  foreach (var result in search_response["results"])
                  {
                      var part = result["item"];
                      
                      // Print matched part
                      Console.WriteLine(part["brand"]["name"] + " - " + part["mpn"]);
                  }
              }
      
              // -- your API key -- (https://octopart.com/api/register)
              private const string APIKEY = "REPLACE_ME";
          }
      }
      

      Download examples/parts_search.cs »
    • VB.NET

      Imports Newtonsoft.Json
      Imports RestSharp
      Imports System
      
      Public Module PartsSearch
          Public Sub ExecuteSearch()
              ' -- your search query --
              Dim query As String = "solid state relay"
      
              Dim octopartUrlBase As String = "http://octopart.com/api/v3"
              Dim octopartUrlEndpoint As String = "parts/search"
              Dim apiKey As String = PartsSearch.APIKEY
      
              ' Create the search request
              Dim client = New RestClient(octopartUrlBase)
              Dim req = New RestRequest(octopartUrlEndpoint, Method.GET) _
                              .AddParameter("apikey", apiKey) _
                              .AddParameter("q", query) _
                              .AddParameter("start", "0") _
                              .AddParameter("limit", "10")
      
              ' Perform the search and obtain results
              Dim data = client.Execute(req).Content
              Dim search_response = JsonConvert.DeserializeObject(data)
      
              ' Print number of hits
              Console.WriteLine(search_response("hits"))
      
              ' Print results
              For Each result In search_response("results")
                  Dim part = result("item")
                  ' Print matched part
                  Console.WriteLine(part("brand")("name") & " - " & part("mpn"))
              Next
          End Sub
      
          ' -- your API key -- (https:'octopart.com/api/register)
          Private Const APIKEY As String = "REPLACE_ME"
      End Module
      

      Download examples/parts_search.vb »
  • HTTP Responses

    These are some common HTTP responses and their likely causes:

    • 200 OK: The request was completed successfuly
    • 400 Bad Request: The request failed validation

• GET /parts/get_multi - Fetch multiple parts simultaneously
  • Description

    This endpoint returns multiple parts simultaneously by primary key. The fetch key for each part is its 'uid'. Missing parts will also be missing from the response list.

    URL Arguments

    Argument	Datatype	Default
    uid[]	string	None

    • uid[]
      The uid for an individual part. Append multiple url arguments to fetch multiple parts (up to 20).

    See Universal URL Arguments.

    Response Object

    This method returns a JSON object mapping uids to <Part objects>.

  • Examples
    • Python

      import json
      import urllib
      
      url = 'http://octopart.com/api/v3/parts/get_multi?'
      url += '?apikey=REPLACE_ME'
      
      args = [
         ('uid[]', '103cdb613d20cffb'),
         ('uid[]', '2a68e3620f0cf5af')
         ]
      
      url += "&" + urllib.urlencode(args)
      
      data = urllib.urlopen(url).read()
      server_response = json.loads(data)
      
      # print brands, mpn's
      for (uid, part) in server_response.items():
         print part['brand']['name']
         print part['mpn']
      

      Download examples/parts_get_multi.py »
    • Ruby

      require 'rubygems'
      require 'json'
      require 'net/http'
      
      url = "http://octopart.com/api/v3/parts/get_multi"
      url += "?apikey=REPLACE_ME"
      
      uids = [
         "103cdb613d20cffb",
         "2a68e3620f0cf5af"
         ]
      
      urlargs = []
      uids.each do |uid|
         urlargs.push("uid[]=" + uid)
      end
      
      url += "&" + urlargs.join("&")
      
      resp = Net::HTTP.get_response(URI.parse(url))
      server_response = JSON.parse(resp.body)
      
      # print brands and mpn's
      server_response.keys.each do |key|
         puts server_response[key]['brand']['name']
         puts server_response[key]['mpn']
      end
      

      Download examples/parts_get_multi.rb »
    • JavaScript

      <script src="http://code.jquery.com/jquery-1.11.0.js"></script>
      <script>
          var url = "http://octopart.com/api/v3/parts/get_multi";
          url += "?apikey=REPLACE_ME";
          url += "&callback=?";
      
          var args = {
              uid: [
                  "103cdb613d20cffb",
                  "2a68e3620f0cf5af"
              ]
          };
      
          $.getJSON(url, args, function(parts) {
              // iterate through parts
              $.each(parts, function(i, part) {
                  console.log(part['brand']['name']);
                  console.log(part['mpn']);
              });
          });
      </script>
      

      Download examples/parts_get_multi.html »
    • C Sharp

      namespace OctopartApi
      {
          using Newtonsoft.Json;
          using RestSharp;
          using System;
      
          public static class PartsGetMulti
          {
              public static void ExecuteSearch()
              {
                  // -- your search query --
                  string id1 = "103cdb613d20cffb";
                  string id2 = "2a68e3620f0cf5af";
      
                  string octopartUrlBase = "http://octopart.com/api/v3";
                  string octopartUrlEndpoint = "parts/get_multi";
                  string apiKey = APIKEY;
      
                  // Create the search request
                  var client = new RestClient(octopartUrlBase);
                  var req = new RestRequest(octopartUrlEndpoint, Method.GET)
                              .AddParameter("apikey", apiKey)
                              .AddParameter("uid[]", id1)
                              .AddParameter("uid[]", id2);
      
                  // Perform the search and obtain results
                  var data = client.Execute(req).Content;
                  var server_response = JsonConvert.DeserializeObject<dynamic>(data);
      
                  // Print brands, mpn's
                  foreach (var part in server_response)
                  {
                      Console.WriteLine(part.Value["brand"]["name"]);
                      Console.WriteLine(part.Value["mpn"]);
                  }
              }
      
              // -- your API key -- (https://octopart.com/api/register)
              private const string APIKEY = "REPLACE_ME";
          }
      }
      

      Download examples/parts_get_multi.cs »
    • VB.NET

      Imports Newtonsoft.Json
      Imports RestSharp
      Imports System
      
      Public Module PartsGetMulti
          Public Sub ExecuteSearch()
              ' -- your search query --
              Dim id1 As String = "103cdb613d20cffb"
              Dim id2 As String = "2a68e3620f0cf5af"
      
              Dim octopartUrlBase As String = "http://octopart.com/api/v3"
              Dim octopartUrlEndpoint As String = "parts/get_multi"
              Dim apiKey As String = PartsGetMulti.APIKEY
      
              ' Create the search request
              Dim client = New RestClient(octopartUrlBase)
              Dim req = New RestRequest(octopartUrlEndpoint, Method.GET) _
                              .AddParameter("apikey", apiKey) _
                              .AddParameter("uid[]", id1) _
                              .AddParameter("uid[]", id2)
      
              ' Perform the search and obtain results
              Dim data = client.Execute(req).Content
              Dim server_response = JsonConvert.DeserializeObject(data)
      
              ' Print brands, mpn's
              For Each part In server_response
                  Console.WriteLine(part.Value.GetValue("brand").GetValue("name"))
                  Console.WriteLine(part.Value.GetValue("mpn"))
              Next
          End Sub
      
          ' -- your API key -- (https:'octopart.com/api/register)
          Private Const APIKEY As String = "REPLACE_ME"
      End Module
      

      Download examples/parts_get_multi.vb »
  • HTTP Responses

    These are some common HTTP responses and their likely causes:

    • 200 OK: Request was completed successfuly