API Version 2

The TrustedParts.com API receives search requests via HTTPS POST. It supports both JSON and XML requests and responses. Please indicate with your requests which format you would like to use by including the Content-Type and Accept headers set to either "application/json" or "application/xml".

The url for the API is: https://api.trustedparts.com/v2/search

Changes from Version 1

Version 2 of the TrustedParts.com API contains a number of very valuable enhancements.

Results By Product Instead of By Distributor

Version 1 of our API presented the results segmented by distributor. This imposed some limitations on how useful the results could be and how much information they could contain. Version 2 presents results segmented by product. This offers a number of advantages:

• When making a request for multiple part numbers, it is now easier to distinguish which result is for which part number.
• Basic information about each product, like manufacturer, part number, and TrustedParts.com product URL is included only once instead of being duplicated for each distributor.
• Additional details about each product can be included. See Enhanced Product Details below.
• When doing partial part number searches, it is easier to determine which products are included in the results.

Enhanced Product Details

Technical product specifications, lifecycle risk, and supply chain risk can now be included in the results. Please email user-requests@trustedparts.com to see if our policies allow this information to be provided to you.

Simplified Request Format

The Manufacturers and Distributors filter parameters were converted from objects into simple arrays. Also, parameter names were standardized to use PascalCase for consistency.

Migrating to Version 2

If you are currently using version 1 of the TrustedParts API, you will need to make the following changes to switch to version 2.

• Adjust your integration to use the new URL, https://api.trustedparts.com/v2/search.
• Adjust the request parameters to be PascalCase. For example, APIKey becomes ApiKey, etc.
• If you are using manufacturer filters, change from supplying those as an array of objects to supplying them as an array of strings.
• If you are using distributor filters, change from supplying those in an array of objects to supplying them as an array of strings.
• Update your result processing to the new result by part data model.

Technical Documentation

We have detailed technical documentation in Swagger format. That documentation is interactive and supports making sample requests using your API key. To make a sample request from the Swagger documentation, expand the POST endpoint, click Try it out, adjust the request parameters, and click Execute. Please note that you must adjust the request parameters where indicated for the request to succeed.

Request Fields

Here is a summary of the API's request paramters. For more details, please reference the Swagger documentation.

*Required

Name	Value	Additional Information
CompanyId*	Enter the assigned company identifier	The assigned company identifier can be found on the API Credentials page.
ApiKey*	Enter the assigned API key	The assigned API key can be found on the API Credentials page.
Queries*		Add a separate Queries section for each part number search. Note: If you enter multiple part numbers, an exact match search will be performed for each part number. Partial match results are only available for single part number requests.
• SearchToken*	Enter the search term	The search term must be at least two characters long.
• Manufacturers	Enter an array of manufacturer names	Add this parameter to limit the search results to one or more manufacturers. Omit this paramter to search all authorized manufacturers. See our List of Manufacturer Names for supported manufacturers.
CountryCode	Enter a two-character ISO code or leave blank for geolocation	Leave this field blank if you would like us to geolocate the SourceIP parameter and use the country that the IP address is from. If you use the TrustedParts.com API to provide results on a website, this allows you to provide regional results to each user without any effort on your part.
CurrencyCode	Enter a three-character ISO code	If left blank, the search results default to USD.
Distributors	Enter an array of distributor names	Add this parameter to limit a search to one or more distributors. Omit this parameter to search all authorized distributors. See our List of Distributor Names for supported distributors.
InStockOnly*	Set to true or false	Set to true to view in-stock results only. Set to false to view all results.
ExactMatch*	Set to true or false	Set to true to view parts that match the SearchToken exactly. Set to false to include partial match results. Note: Partial match results are only available for single part number requests where the IsCrawler parameter is false or omitted. Most punctuation and spacing are ignored when determining what is an exact match. For instance, BAT-54C is an exact match for the SearchToken BAT54C.
IsCrawler*	Set to true or false	Set to true if the end user is a crawler or bot (e.g. Google, Bing, Baidu). Set to false if the end user is not a crawler or if undetermined.
UseCachedData	Set to true or false	If this parameter is not supplied or set to false, the TrustedParts.com API will provide results based on real-time stock and pricing services provided by participating distributors. This is the preferred setting since it yields the most accurate results. However, if you need extremely fast responses or need to submit a high volume of requests in a short period of time, you may set this parameter to true. This will direct the TrustedParts.com API to use an optimized search process that retrieves results from locally-cached data instead of real-time data. Note: If the IsCrawler parameter is set to true or the TrustedParts.com API detects that a request is made on behalf of a crawler, the UseCachedData parameter is ignored since results for crawlers are always retrieved from locally cached data.
UserAgent*	Enter user agent	For requests made by a web site: Provide the web browser user agent of the end user or crawler who will view the results. Please ensure the accuracy of this value so that TrustedParts.com can verify the identity of users who receive results. For requests made by an internal application instead of a web site: Provide the name of the application that is making the request and, if possible, a unique user identifier (preferably an ID number; no personally identifiable information should be supplied).
SourceIp	Enter the IP address	For requests made by a web site: Provide the IP (Internet Protocol) address of the end user or crawler who will view the results. Please ensure the accuracy of this value so that TrustedParts.com can verify the identity of users who receive results. For requests made by an internal application instead of a web site: Omit this property; the public IP address of your system will be used as the request IP address. Note: Please do not provide an internal IP address for this value. Geolocation: When the CountryCode parameter is omitted or left blank, the SourceIP parameter will be used to geolocate the request and provide regional results.