⚡ Neptun Monitors API

Add Product

post

Adds a PID to the custom PID list of your cookgroup for the specified site.

Authorizations

X-SignaturestringRequired

HMAC-based authentication using three headers:

X-API-Key: public API key of the cookgroup.
X-Timestamp: UNIX timestamp in seconds used in the signature.
X-Signature: base64-encoded HMAC-SHA256 of the string, signed with the API secret:

METHOD + PATH + X-Timestamp

For example:

stringToSign = "POST" + "/v1/public/products/add" + "1764609321"
stringToSign = "GET" + "/v1/public/pings/ws" + "1764609321"

API key and secret can be found in your dashboard.

Body

pidstringRequired

Product PID to add.

Example: 7149445

siteIdstringRequired

Site identifier (e.g. "argos").

Example: argos

Responses

200

Product successfully added.

application/json

okbooleanOptionalExample: true

400

Bad request.

application/json

401

Authentication failed (missing or invalid auth headers/signature).

application/json

500

Internal server error.

application/json

post

/v1/public/products/add

POST /v1/public/products/add HTTP/1.1
Host: api.neptun-monitors.com
X-Signature: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "pid": "7149445",
  "siteId": "argos"
}

{
  "ok": true
}

List Products

get

List the Custom PIDs and Blacklist PIDs of your cookgroup for the specified site.

Authorizations

X-SignaturestringRequired

HMAC-based authentication using three headers:

X-API-Key: public API key of the cookgroup.
X-Timestamp: UNIX timestamp in seconds used in the signature.
X-Signature: base64-encoded HMAC-SHA256 of the string, signed with the API secret:

METHOD + PATH + X-Timestamp

For example:

stringToSign = "POST" + "/v1/public/products/add" + "1764609321"
stringToSign = "GET" + "/v1/public/pings/ws" + "1764609321"

API key and secret can be found in your dashboard.

Query parameters

siteIdstringRequiredExample: adidas

Responses

200

Products successfully listed.

application/json

siteIdstringRequired

Site identifier.

Example: adidas

blacklistPIDsstring[]Required

Blacklist PIDs of the site.

Example: ["JR8844"]

customPIDsstring[]Required

Custom PIDs of the site.

Example: ["JR0035","KT3436"]

customPIDs2string[]Required

Custom PIDs 2 of the site (Offer IDs on amazon).

onlyCustomPIDsbooleanRequired

Monitor only the custom PIDs.

Example: false

okbooleanRequiredExample: true

400

Bad request.

application/json

401

Authentication failed (missing or invalid auth headers/signature).

application/json

500

Internal server error.

application/json

get

/v1/public/products/list

GET /v1/public/products/list?siteId=text HTTP/1.1
Host: api.neptun-monitors.com
X-Signature: YOUR_API_KEY
Accept: */*

{
  "siteId": "adidas",
  "blacklistPIDs": [
    "JR8844"
  ],
  "customPIDs": [
    "JR0035",
    "KT3436"
  ],
  "customPIDs2": [],
  "onlyCustomPIDs": false,
  "ok": true
}

WebSocket Stream

get

Upgrades the connection to a WebSocket used to receive product pings for your cookgroup.

After the WebSocket is established, the client will receive the list of sites he have the access to with this format:

The SitesResponse object

Attributes

The SitesResponse object

{
  "sites": [
    {
      "id": "amazon",
      "name": "Amazon",
      "regions": "FR,BE,DE,ES,IT,NL,UK,US,SE,JP"
    }
  ]
}

Example:

{
  "sites": [
    {
      "id": "www.asphaltgold.com",
      "name": "Asphaltgold",
      "regions": ""
    },
    {
      "id": "amazon",
      "name": "Amazon",
      "regions": "FR,BE,DE,ES,IT,NL,UK,US,SE,JP"
    },
    {
      "id": "micromania",
      "name": "Micromania",
      "regions": ""
    }
  ]
}

Then, the client MUST send a subscribe payload:

The WebSocketSubscribeMessage object

Attributes

actionstring · enumRequiredPossible values:

regionsstring[] · min: 1Required

List of regions to subscribe to (or ["all"]).

sitesstring[] · min: 1Required

List of site IDs to subscribe to (or ["all"]).

The WebSocketSubscribeMessage object

{
  "action": "subscribe",
  "regions": [
    "all"
  ],
  "sites": [
    "all"
  ]
}

Example for subscribing to snipes and footlocker for UK and FR only:

{
  "action": "subscribe",
  "regions": ["fr", "uk"],
  "sites": ["snipes", "footlocker"]
}

Example for subscribing to all regions:

{
  "action": "subscribe",
  "regions": ["all"],
  "sites": ["snipes", "footlocker"]
}

Example for subscribing to all sites and all regions:

{
  "action": "subscribe",
  "regions": ["all"],
  "sites": ["all"]
}

Please note, using the region parameter, it will only filter out multiple regions websites like amazon. For example, if you have the alternative package and put "IT" only in the regions, it will not filter out micromania, but you will receive pings from Amazon IT region only.

Format of the pings you will receive:

The ProductPing object

Attributes

Product ping payload pushed over the WebSocket.

pidstringRequired

Unique identifier for the product

namestringRequired

imageUrlstring · nullableOptional

pricestring · nullableOptional

urlstringRequired

URL with our redirect, prefer this option.

rawUrlstringRequired

sizesstring[] · nullableOptional

sizesStockstring[] · nullableOptional

If present, indicates the stock for the corresponding index in the "sizes" field.

totalStockinteger · nullableOptional

If present, indicates the total stock of the product.

offerIdstring · nullableOptional

regionstring · nullableOptional

Region of the monitor (lowercase).

websiteNamestringRequired

websiteIdstringRequired

Site ID used for filtering.

websiteUrlstringRequired

The ProductPing object

{
  "pid": "text",
  "name": "text",
  "imageUrl": "text",
  "price": "text",
  "url": "text",
  "rawUrl": "text",
  "sizes": [
    "text"
  ],
  "sizesStock": [
    "text"
  ],
  "totalStock": 1,
  "offerId": "text",
  "region": "text",
  "websiteName": "text",
  "websiteId": "text",
  "websiteUrl": "text"
}

Example:

{
  "pid": "368893",
  "name": "Collezione 151 Zapdos-ex (IT)",
  "imageUrl": "https://federicstore.it/wp-content/uploads/2023/06/PKEXBOX-151-ZAPDOS-IT.png",
  "price": null,
  "url": "https://l.neptun-monitors.com/NMxfuW",
  "rawUrl": "https://federicstore.it/prodotto/collezione-151-zapdos-ex-it-2/",
  "sizes": null,
  "sizesStock": null,
  "totalStock": null,
  "region": null,
  "offerId": null,
  "websiteName": "Federicstore",
  "websiteId": "federicstore",
  "websiteUrl": "https://federicstore.it"
}

Other example:

{
  "pid": "B0DXFRZR9S",
  "name": "Pokémon - Trading Card Game: Surprise Box Crimson \u0026 Purple - Prismatic Developments (4 Booster Packs \u0026 1 Holographic Promo Card)",
  "imageUrl": "https://m.media-amazon.com/images/I/818MvPeHrDL.jpg",
  "price": "69.95€",
  "url": "https://l.neptun-monitors.com/iCNpOw",
  "rawUrl": "https://www.amazon.de/dp/B0DXFRZR9S",
  "sizes": [
    "Only 1 left in stock."
  ],
  "sizesStock": null,
  "totalStock": null,
  "region": "de",
  "offerId": "aExVRYv3vr3th8X796mDMX6gVsMbC7pjGkwoUBSLWsgMuccCKi%2B6cJPSUdGb%2FbXMi6ex%2BfXria030HkxLTxgOP8ZfRKGsT8YcUoyj1LsefXsztzwVHRio7WnfQw3QIFAL7%2By%2Bhi6UEbnReHjfauYGtnArqi9%2F3MqQwbqFipFKMwuDnDiGGmt7cBHa732u02j",
  "websiteName": "",
  "websiteId": "amazon",
  "websiteUrl": "https://www.amazon.de"
}

Authorizations

X-SignaturestringRequired

HMAC-based authentication using three headers:

X-API-Key: public API key of the cookgroup.
X-Timestamp: UNIX timestamp in seconds used in the signature.
X-Signature: base64-encoded HMAC-SHA256 of the string, signed with the API secret:

METHOD + PATH + X-Timestamp

For example:

stringToSign = "POST" + "/v1/public/products/add" + "1764609321"
stringToSign = "GET" + "/v1/public/pings/ws" + "1764609321"

API key and secret can be found in your dashboard.

Responses

101

WebSocket protocol upgrade successful.

400

Bad request.

application/json

401

Authentication failed (missing or invalid auth headers/signature).

application/json

500

Internal server error while upgrading to WebSocket.

application/json

get

/v1/public/pings/ws

GET /v1/public/pings/ws HTTP/1.1
Host: api.neptun-monitors.com
X-Signature: YOUR_API_KEY
Accept: */*

No content

PreviousNeptun AutoPing

Last updated 2 months ago

hashtagAdd Product

hashtagList Products

hashtagWebSocket Stream

hashtagThe SitesResponse object

The SitesResponse object

hashtagThe WebSocketSubscribeMessage object

The WebSocketSubscribeMessage object

hashtagThe ProductPing object

The ProductPing object

Add Product

List Products

WebSocket Stream

The SitesResponse object

The WebSocketSubscribeMessage object

The ProductPing object