Introduction

5min

The Pricemoov API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Hosts

The REST API lets you interact directly with Pricemoov from anything that can send an HTTP request. All API access must use HTTPS.

The primary host is api.pricemoov.com for write and read operations.

Format

The entire API uses JSON encoded as UTF-8.

The body of POST and PUT requests must be either a JSON object or a JSON array (depending on the particular endpoint) and their Content-Type header should be set to application/json; charset=UTF-8.

The body of responses is always a JSON object, and their Content-Type is always application/json; charset=UTF-8.

Parameters

Unless otherwise stated, parameters must be passed:

  • In the URL query string for GET and DELETE requests
  • In the request body for PUT and POST requests

Parameters passed in the URL must be properly URL-encoded, using the UTF-8 encoding for non-ASCII characters. Furthermore, the plus character (+) is interpreted as a space (it’s, therefore, an alternative to %20).

Pagination

Default parameters for all GET endpoints are

offset

limit

type: integer, default: 0, Optional

type: integer, default: 25, Optional

Errors

The Pricemoov API uses the following error codes:

Error Code

Meaning

400

Bad Request -- Your request is invalid.

401

Unauthorized -- Your API key is wrong.

403

Forbidden -- The entity requested is hidden for administrators only.

404

Not Found -- The specified entity could not be found.

405

Method Not Allowed -- You tried to access an entity with an invalid method.

406

Not Acceptable -- You requested a format that isn't json.

409

Conflict

410

Gone -- The entity requested has been removed from our servers.

429

Too Many Requests -- You're requesting too many entities! Slow down!

500

Internal Server Error -- We had a problem with our server. Try again later.

503

Service Unavailable -- We're temporarily offline for maintenance. Please try again later.





Versioning

The current version of the API is v1.

Updated 17 Sep 2024
Doc contributor
Doc contributor
Did this page help you?