/ Documentation

Components API

Industrial Component Marketplace - Search and discover industrial components with comprehensive specifications, pricing, and manufacturer information. Your central registry for automation parts.

Overview

Component Categories

• SENSOR: Temperature, pressure, flow sensors
• ACTUATOR: Linear and rotary actuators
• MOTOR: AC/DC motors, servo motors
• VALVE: Control and safety valves
• CONTROLLER: PLCs, HMIs, drives
• SAFETY: Emergency stops, light curtains

Features

• Advanced search and filtering
• Real-time pricing information
• Manufacturer verification
• Quality ratings and reviews
• Technical specifications
• Availability tracking

Component Data Model

Component Properties

Core fields and specifications for industrial components

{
  "id": "comp_001_abc123",
  "name": "Temperature Transmitter 4-20mA",
  "manufacturer": "Rosemount",
  "manufacturer_part_number": "3144P",
  "model_series": "3144P Series",
  "description": "Smart temperature transmitter with HART protocol",
  "category": "SENSOR",
  "subcategory": "Temperature",
  "status": "ACTIVE",
  "specifications": {
    "measurement_range": "-200°C to +850°C",
    "accuracy": "±0.1%",
    "output_signal": "4-20mA with HART",
    "power_supply": "12-45V DC"
  },
  "dimensions": {
    "length_mm": 150,
    "width_mm": 80,
    "height_mm": 120,
    "weight_kg": 1.2
  },
  "electrical_specs": {
    "supply_voltage": "12-45V DC",
    "output_current": "4-20mA",
    "loop_resistance": "0-1400 ohms"
  },
  "typical_price_usd": 1250.00,
  "price_range_min_usd": 1200.00,
  "price_range_max_usd": 1350.00,
  "availability_status": "In Stock",
  "lead_time_weeks": 2,
  "quality_rating": 4.8,
  "user_reviews_count": 127,
  "verified_by_manufacturer": true,
  "datasheet_url": "https://example.com/datasheet.pdf",
  "manual_url": "https://example.com/manual.pdf",
  "cad_models_url": "https://example.com/cad-models.zip"
}

Component Status

ACTIVE

Component is currently available and in production.

EOL_ANNOUNCED

End of life announced. Limited availability remaining.

DISCONTINUED

Component is no longer in production or available.

API Endpoints

GET/components/searchAuth Required

Search Components

Search industrial components with advanced filtering options including category, manufacturer, price range, and availability.

Parameters

qstring

Search query - searches name, manufacturer, part number, and description

categorystring

Filter by category (SENSOR, ACTUATOR, MOTOR, VALVE, CONTROLLER, DRIVE, PUMP, etc.)

manufacturerstring

Filter by manufacturer name (partial match supported)

min_pricenumber

Minimum price in USD

max_pricenumber

Maximum price in USD

verified_onlyboolean

Show only manufacturer-verified components (default: false)

in_stock_onlyboolean

Show only in-stock components (default: false)

limitinteger

Maximum results (max: 100, default: 50)

offsetinteger

Results to skip for pagination (default: 0)

Response

Responsejson

[
  {
    "id": "comp_001_abc123",
    "name": "Temperature Transmitter 4-20mA",
    "manufacturer": "Rosemount",
    "manufacturer_part_number": "3144P",
    "category": "SENSOR",
    "status": "ACTIVE",
    "typical_price_usd": 1250.00,
    "price_display": "$1,250.00",
    "availability_status": "In Stock",
    "quality_rating": 4.8,
    "user_reviews_count": 127,
    "verified_by_manufacturer": true
  },
  {
    "id": "comp_002_def456",
    "name": "Servo Motor 1kW",
    "manufacturer": "Siemens",
    "manufacturer_part_number": "1FK7083-5AF71-1SG3",
    "category": "MOTOR", 
    "status": "ACTIVE",
    "typical_price_usd": null,
    "price_display": "$2,400.00 - $2,800.00",
    "availability_status": "Backorder",
    "quality_rating": 4.6,
    "user_reviews_count": 89,
    "verified_by_manufacturer": true
  }
]

Try it out

cURLbash

curl -X GET "https://sapienstream.com/api/components/search" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

GET/components/{component_id}Auth Required

Get Component Details

Retrieve detailed information about a specific component including full specifications, pricing, documentation, and market data.

Parameters

component_idstringRequired

Unique component identifier

Response

Responsejson

{
  "id": "comp_001_abc123",
  "name": "Temperature Transmitter 4-20mA",
  "manufacturer": "Rosemount",
  "manufacturer_part_number": "3144P",
  "model_series": "3144P Series",
  "description": "Smart temperature transmitter with HART protocol for industrial process measurement",
  "category": "SENSOR",
  "subcategory": "Temperature",
  "status": "ACTIVE",
  "specifications": {
    "measurement_range": "-200°C to +850°C",
    "accuracy": "±0.1%",
    "output_signal": "4-20mA with HART",
    "response_time": "90% in 8 seconds",
    "stability": "±0.1% for 5 years"
  },
  "dimensions": {
    "length_mm": 150,
    "width_mm": 80,
    "height_mm": 120,
    "weight_kg": 1.2
  },
  "operating_conditions": {
    "temperature_range": "-40°C to +85°C",
    "humidity": "0-100% RH",
    "vibration": "4g at 10-2000 Hz",
    "shock": "100g for 6ms"
  },
  "electrical_specs": {
    "supply_voltage": "12-45V DC",
    "output_current": "4-20mA",
    "loop_resistance": "0-1400 ohms",
    "power_consumption": "1W max"
  },
  "typical_price_usd": 1250.00,
  "price_range_min_usd": 1200.00,
  "price_range_max_usd": 1350.00,
  "availability_status": "In Stock",
  "lead_time_weeks": 2,
  "quality_rating": 4.8,
  "user_reviews_count": 127,
  "average_rating": 4.8,
  "verified_by_manufacturer": true,
  "datasheet_url": "https://assets.emerson.com/documents/automation/product-data-sheet-rosemount-3144p-temperature-transmitter-en-68467.pdf",
  "manual_url": "https://www.emerson.com/documents/automation/manual-rosemount-3144p-temperature-transmitter-en-68468.pdf",
  "cad_models_url": "https://www.emerson.com/en-us/catalog/rosemount-3144p#cad"
}

Try it out

cURLbash

curl -X GET "https://sapienstream.com/api/components/{component_id}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

GET/components/categories/statsAuth Required

Category Statistics

Get aggregated statistics about components by category including total counts, in-stock availability, average pricing, and verification status.

Response

Responsejson

[
  {
    "category": "SENSOR",
    "total_components": 2847,
    "in_stock": 2156,
    "average_price_usd": 685.50,
    "verified_components": 2203
  },
  {
    "category": "MOTOR",
    "total_components": 1923,
    "in_stock": 1445,
    "average_price_usd": 1250.75,
    "verified_components": 1678
  },
  {
    "category": "VALVE",
    "total_components": 1654,
    "in_stock": 1234,
    "average_price_usd": 890.25,
    "verified_components": 1456
  },
  {
    "category": "CONTROLLER",
    "total_components": 987,
    "in_stock": 743,
    "average_price_usd": 2150.00,
    "verified_components": 901
  }
]

Try it out

cURLbash

curl -X GET "https://sapienstream.com/api/components/categories/stats" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

GET/components/manufacturers/topAuth Required

Top Manufacturers

Get top manufacturers ranked by component count, average quality rating, and verification status.

Parameters

limitinteger

Number of manufacturers to return (max: 50, default: 20)

Response

Responsejson

[
  {
    "manufacturer": "Siemens",
    "component_count": 1247,
    "average_rating": 4.6,
    "verified_components": 1189,
    "total_reviews": 8934
  },
  {
    "manufacturer": "ABB",
    "component_count": 1156,
    "average_rating": 4.5,
    "verified_components": 1098,
    "total_reviews": 7823
  },
  {
    "manufacturer": "Schneider Electric",
    "component_count": 1034,
    "average_rating": 4.4,
    "verified_components": 967,
    "total_reviews": 6712
  },
  {
    "manufacturer": "Emerson",
    "component_count": 892,
    "average_rating": 4.7,
    "verified_components": 856,
    "total_reviews": 5934
  }
]

Try it out

cURLbash

curl -X GET "https://sapienstream.com/api/components/manufacturers/top" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Future Endpoints

Under Development

The following endpoints are planned for future implementation

POST/components/{component_id}/reviews- Add component reviews

GET/components/{component_id}/price-history- Get pricing history

POST/components/bulk-upload- Bulk upload from catalogs

Search Examples

Common Search Patterns

Search by Part Number

GET /components/search?q=3144P&manufacturer=Rosemount

Filter by Category and Price

GET /components/search?category=SENSOR&min_price=500&max_price=2000&verified_only=true

In-Stock Components Only

GET /components/search?in_stock_only=true&category=MOTOR&limit=25

Manufacturer Search

GET /components/search?manufacturer=Siemens&category=CONTROLLER&verified_only=true

Error Responses

Common Error Codes

400 Bad Request

{
  "detail": "Invalid category: 'INVALID_CAT' not in valid categories"
}

404 Not Found

{
  "detail": "Component not found"
}

422 Validation Error

{
  "detail": "Limit must be between 1 and 100"
}

403 Forbidden

{
  "detail": "Insufficient permissions for components read access"
}