API Version 1
Please note: This version of the TrustedParts.com API is deprecated. Please use the current version.
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/api/Search/Query
Technical Documentation
We have detailed technical documentation in Swagger format. That documentation is interactive and supports making sample requests to our API using your API key.
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 part number | The part number must be at least 3 characters long. |
• Manufacturers | Add this section to limit the search results to one or more manufacturers. Omit this section to search all authorized manufacturers. | |
- Name | Enter the name of the manufacturer | Add separate Name elements for each manufacturer to search. 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 | Add this section to limit a search to one or more distributors. Omit this section to search all authorized distributors. | |
• Name | Enter the name of the distributor | Add separate Name elements for each distributor to search. 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: Provide an external IP address used by your location. 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. |