Get started

Your first request

Authenticate, verify your credential, and retrieve live channel data in about five minutes.

1 Before you begin

You need a Pricemind account and an active API key. Create and revoke keys from the app's API keys screen.

Keep credentials on your server

Never embed an API key in browser code, a mobile application, or a public repository.

2 Store your key

Put the credential in an environment variable so examples stay safe to paste.

Terminal
export PRICEMIND_API_KEY="pmk_v1_your-key-id.your-secret"

3 Verify the credential

The principal endpoint returns the account, effective permissions, visible operation IDs, and credential constraints.

cURL
curl --request GET \
  --url https://api.pricemind.io/v1/me \
  --header "X-API-Key: $PRICEMIND_API_KEY" \
  --header "Accept: application/json"
Why start with /v1/me?

It requires only a valid credential and helps diagnose scope, environment, IP restriction, and rate-limit setup.

4 List your channels

Request the channels visible to your API key. Integration-bound keys return only channels attached to that integration.

cURL
curl --request GET \
  --url https://api.pricemind.io/v1/channels \
  --header "X-API-Key: $PRICEMIND_API_KEY" \
  --header "Accept: application/json"

Example response

200 response
{
  "data": [
    {
      "channel_id": 123,
      "name": "My storefront",
      "channel": "ecommerce",
      "currency": "EUR",
      "vat": 0.2,
      "status": 1
    }
  ],
  "count": 1,
  "next_cursor": null
}

5 Build from here

Publish a product price with POST /v1/channels/{channelId}/prices.

Trigger a tracked crawl with a safe idempotency key.

Discover enabled operations with GET /v1/capabilities.

Continue to the API reference →