techspecs v2.0.1

Introduction

TechSpecs Python provides easy access to the standardized technical specifications of the world's consumer electronics, including the latest smartphones, tablets, smartwatches, laptops, monitors, TVs and more.

Documentation

• See the TechSpecs API Docs

API Key

• Signup to get your TechSpecs API Key

Requirements

• NodeJS v12.x or ES6

Installation

npm install techspecs

Usage

The library needs to be configured with your TechSpecs api key and base URL which is available in your TechSpecs Dashboard.

Set techspecs_api_key to your key value and techspecs_base_url to your base value.

Product Search

Search for a device by specifying it's model name, version number or features

// Search for a product by name, version or features
import { techspecs } from "techspecs";

// self invoking async function
async function search() {

  // TechSpecs API Key
  const techspecs_key = "techspecs_api_key";

  // TechSpecs base 
  const techspecs_base_url = "https://api.techspecs.io";

  const query = {
    keyword: "iPhone 13", // product name or version number to search
    category: "", // Category to search. Leave empty to search all categories
  };

  // choose between "pretty" or "raw" mode for viewing response
  const response = await techspecs.product_search(techspecs_base_url, query, techspecs_api_key, (mode = "pretty"));

  // print the search results
  console.log(response);
}

Product Details

// Get the standardized specifications of a specified product

import { techspecs } from "techspecs";

// self invoking async function
async function getDetails() => {

  // TechSpecs API Key
  const techspecs_key = "techspecs_api_key";

  // TechSpecs base 
  const techspecs_base_url = "https://api.techspecs.io";

  // TechSpecs product id
  const techspecs_id = "63e96260ff7af4b68a3041cd";

  // choose between "pretty" or "raw" mode for viewing response
  const response = await techspecs.product_detail(
    techspecs_base_url,
    techspecs_product_id,
    techspecs_api_key,
    (mode = "pretty")
  );

  // print the specifications of the product
  console.log(response);
}

List all categories

import { techspecs } from "techspecs";

// self invoking async function
async function getAllCategories() => {

  // TechSpecs API Key
  const techspecs_key = "techspecs_api_key";

  // TechSpecs base
  const techspecs_base_url = "https://api.techspecs.io";

  // choose between "pretty" or "raw" mode for viewing response
  const response = await techspecs.get_all_categories(
    techspecs_base_url,
    techspecs_api_key,
    (mode = "pretty")
  );

  // print the list of all categories
  console.log(response);
}

Get all brands

import { techspecs } from "techspecs";

// self invoking async function
async function getBrands() => {

  // TechSpecs API Key
  const techspecs_key = "techspecs_api_key";

  // TechSpecs base
  const techspecs_base_url = "https://api.techspecs.io";

  // choose between "pretty" or "raw" mode for viewing response
  const response = await techspecs.get_all_brands(
    techspecs_base_url,
    techspecs_api_key,
    (mode = "pretty")
  );

  // print the list of all brands
  console.log(response);
}

Get All Products

List all products by brand, category and release date

// List all products by brand, category and release date
import { techspecs } from "techspecs";

// self invoking async function
async function getProducts() => {
  // TechSpecs API Key
  const techspecs_key = "techspecs_api_key";

  // TechSpecs base 
  const techspecs_base_url = "https://api.techspecs.io";

  // enter the page number to fetch results from
  const page = 0;

  // type in the name of the brand you're looking for or leave this field empty to see results from all brands
  const brand = ["Apple"];

  // type in the name of the category you're looking for or leave this field empty to see results from all categories
  const category = ["Smartphones"];

  // please provide a date range to narrow your search. Leave this field empty to fetch all results from all dates
  const date = {
    from: "2010-01-01", // YYYY-MM-DD
    to: "2022-03-15", // YYYY-MM-DD
  };

  // choose between "pretty" or "raw" mode for viewing response
  const response = await techspecs.get_all_products(
    techspecs_base_url,
    brand,
    category,
    date,
    page,
    techspecs_api_key,
    "pretty"
  );

  // print the search results
  console.log(response);
}