Jobs

Poll a job as CSV

The same job view as GET /api/jobs/{jobId}, flattened to CSV with one row per offer. Columns are the union of the offer fields present in the response, plus query first and source, country, fetched_at last (all four taken from the job result, never from an offer). Results carrying no offers (not_found, error) produce no rows; X-Offer-Rows reports the row count so an empty export is distinguishable from a broken one. UTF-8 with a BOM and CRLF line endings, RFC 4180 quoting. Settles exactly as the JSON poll does.

Poll a job as CSV

curl --request GET \
  --url https://api-v2.pricepirate.com/api/jobs/{jobId}/csv \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api-v2.pricepirate.com/api/jobs/{jobId}/csv', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-v2.pricepirate.com/api/jobs/{jobId}/csv",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-v2.pricepirate.com/api/jobs/{jobId}/csv"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-v2.pricepirate.com/api/jobs/{jobId}/csv")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

"<string>"

{
  "error": true,
  "message": "<string>"
}

{
  "error": true,
  "message": "<string>"
}

{
  "error": true,
  "message": "<string>"
}

{
  "error": true,
  "message": "<string>"
}

{
  "error": true,
  "message": "<string>"
}

Autorisierungen

x-api-key

string

header

erforderlich

Pfadparameter

jobId

string

erforderlich

Abfrageparameter

delimiter

enum<string>

Standard:,

Field separator. Default ,; use ; or tab for spreadsheet locales that do not split on commas.

Verfügbare Optionen:

,,

;,

tab

Antwort

Terminal job rendered as CSV, one row per offer

The response is of type string.

Poll a job as CSV

curl --request GET \
  --url https://api-v2.pricepirate.com/api/jobs/{jobId}/csv \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api-v2.pricepirate.com/api/jobs/{jobId}/csv', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-v2.pricepirate.com/api/jobs/{jobId}/csv",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-v2.pricepirate.com/api/jobs/{jobId}/csv"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-v2.pricepirate.com/api/jobs/{jobId}/csv")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

"<string>"

{
  "error": true,
  "message": "<string>"
}

{
  "error": true,
  "message": "<string>"
}

{
  "error": true,
  "message": "<string>"
}

{
  "error": true,
  "message": "<string>"
}

{
  "error": true,
  "message": "<string>"
}

Admin API

Price Data API

Hilfe

Produkt

Unternehmen

Poll a job as CSV

Autorisierungen

Pfadparameter

Abfrageparameter

Antwort