Developer Portal › API Reference

REST API Reference

All endpoints are versioned under /api/v1/. Base URL: https://api.nesika.ai

Public endpoints

Product search and market insights require no authentication

Authenticated endpoints

Pass your key in the X-API-Key header

Product Search

Search for products and retrieve pricing intelligence from across the market. No authentication required.

GET/api/v1/products/searchPublic

Search for products by keyword and vendor

Parameters

Name	Type	Required	Description
`q`	string	required	Search query — product name, SKU, or keywords
`vendorId`	string	optional	Filter results to a specific vendor (e.g. kogan, bigw, amazon)
`category`	string	optional	Filter by product category
`page`	integer	optional	Page number — default 1
`pageSize`	integer	optional	Results per page — default 20, max 100

Example Request

curl "https://api.nesika.ai/api/v1/products/search?q=iPhone+16&vendorId=kogan"

Response Shape

{
  "data": {
    "products": [
      {
        "id": "prod_abc123",
        "name": "Apple iPhone 16 128GB",
        "vendor": "kogan",
        "price": 1249.00,
        "currency": "AUD",
        "url": "https://www.kogan.com/...",
        "imageUrl": "https://...",
        "inStock": true,
        "lastScannedAt": "2024-03-15T08:30:00Z"
      }
    ],
    "total": 42,
    "page": 1,
    "pageSize": 20
  }
}

GET/api/v1/products/{id}/pricesPublic

Get current prices for a product across all vendors

Parameters

Name	Type	Required	Description
`id`	string	required	Product ID from a previous search result

Example Request

curl "https://api.nesika.ai/api/v1/products/prod_abc123/prices"

Response Shape

{
  "data": {
    "productId": "prod_abc123",
    "productName": "Apple iPhone 16 128GB",
    "prices": [
      { "vendor": "kogan", "price": 1249.00, "inStock": true },
      { "vendor": "jbhifi", "price": 1299.00, "inStock": true },
      { "vendor": "amazon", "price": 1199.00, "inStock": false }
    ],
    "lowestPrice": 1199.00,
    "lowestVendor": "amazon",
    "averagePrice": 1249.00
  }
}

GET/api/v1/products/{id}/price-history-seriesPublic

Retrieve 30-day price history for a product

Parameters

Name	Type	Required	Description
`id`	string	required	Product ID
`vendorId`	string	optional	Scope history to a single vendor
`days`	integer	optional	Lookback window in days — default 30, max 90

Example Request

curl "https://api.nesika.ai/api/v1/products/prod_abc123/price-history-series?days=30"

Response Shape

{
  "data": {
    "productId": "prod_abc123",
    "series": [
      { "date": "2024-02-15", "price": 1299.00, "vendor": "kogan" },
      { "date": "2024-02-22", "price": 1249.00, "vendor": "kogan" }
    ]
  }
}

Market Insights

Aggregate market intelligence across categories and vendors. No authentication required.

GET/api/v1/insights/marketPublic

Get market-level pricing insights for a category or keyword

Parameters

Name	Type	Required	Description
`q`	string	optional	Keyword or category to analyse
`category`	string	optional	Product category filter

Example Request

curl "https://api.nesika.ai/api/v1/insights/market?category=smartphones"

Response Shape

{
  "data": {
    "category": "smartphones",
    "totalProducts": 1842,
    "avgPrice": 899.00,
    "priceRange": { "min": 299.00, "max": 3499.00 },
    "topVendors": ["kogan", "jbhifi", "amazon"],
    "priceTrend": "declining",
    "periodStart": "2024-02-15",
    "periodEnd": "2024-03-15"
  }
}

Customer Data

Access your workspace's tracked products, competitive positioning, scan results, and pricing insights. Requires API key authentication.

GET/api/v1/me/productsAPI Key

List your workspace's tracked products

Parameters

Name	Type	Required	Description
`query`	string	optional	Search within your tracked products
`status`	string	optional	Filter by status: tracked (default), paused, or all
`page`	integer	optional	Page number
`pageSize`	integer	optional	Results per page — default 20, max 100

Example Request

curl -H "X-API-Key: nes_your_key_here" \
  "https://api.nesika.ai/api/v1/me/products"

Response Shape

{
  "data": {
    "products": [
      {
        "id": "my_prod_xyz",
        "name": "Samsung 65\" QLED TV",
        "sku": "UA65QN900D",
        "price": 3499.00,
        "currency": "AUD",
        "tracked": true,
        "lastScannedAt": "2024-03-15T08:00:00Z"
      }
    ],
    "total": 15,
    "page": 1,
    "pageSize": 20
  }
}

GET/api/v1/me/products/{id}/positionAPI Key

Get competitive price positioning for one of your products

Parameters

Name	Type	Required	Description
`id`	string	required	Your tracked product ID
`timeframe`	string	optional	Analysis window: 7d, 30d (default), or 90d

Example Request

curl -H "X-API-Key: nes_your_key_here" \
  "https://api.nesika.ai/api/v1/me/products/my_prod_xyz/position?timeframe=30d"

Response Shape

{
  "data": {
    "productId": "my_prod_xyz",
    "yourPrice": 3499.00,
    "rank": 2,
    "total": 8,
    "lowestCompetitorPrice": 3299.00,
    "lowestCompetitorVendor": "jbhifi",
    "priceGap": 200.00,
    "priceGapPercent": 5.7
  }
}

GET/api/v1/me/scansAPI Key

List recent price scans for your workspace

Parameters

Name	Type	Required	Description
`limit`	integer	optional	Max scans to return — default 10, max 50
`status`	string	optional	Filter by status: completed, in_progress, failed, or all

Example Request

curl -H "X-API-Key: nes_your_key_here" \
  "https://api.nesika.ai/api/v1/me/scans?limit=5"

Response Shape

{
  "data": {
    "scans": [
      {
        "id": "scan_abc123",
        "status": "completed",
        "startedAt": "2024-03-15T07:00:00Z",
        "completedAt": "2024-03-15T07:42:00Z",
        "productsScanned": 15,
        "priceChangesDetected": 3
      }
    ]
  }
}

GET/api/v1/me/insights/summaryAPI Key

Get a summary of pricing insights for your workspace

Parameters

Name	Type	Required	Description
`timeframe`	string	optional	Analysis window: 7d, 30d (default), or 90d

Example Request

curl -H "X-API-Key: nes_your_key_here" \
  "https://api.nesika.ai/api/v1/me/insights/summary"

Response Shape

{
  "data": {
    "totalTrackedProducts": 15,
    "productsBeingUndercut": 4,
    "productsWithOpportunities": 6,
    "avgPriceGap": -3.2,
    "largestUndercutPercent": 12.4,
    "periodStart": "2024-02-15",
    "periodEnd": "2024-03-15"
  }
}

MCP Server Tools Reference

The Nesika MCP server exposes 12 tools covering all endpoints above, optimised for natural language access via AI agents. See the full tool reference in the in-app docs.

View MCP Tools Reference