Skip to main content
OPTIONS
/
batches
/
transactions
/
universal
/
enrich
Get metadata for the batch universal enrichment endpoint
curl --request OPTIONS \
  --url https://east.sandbox.spade.com/batches/transactions/universal/enrich \
  --header 'X-Api-Key: <api-key>'
import requests

url = "https://east.sandbox.spade.com/batches/transactions/universal/enrich"

headers = {"X-Api-Key": "<api-key>"}

response = requests.options(url, headers=headers)

print(response.text)
const options = {method: 'OPTIONS', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://east.sandbox.spade.com/batches/transactions/universal/enrich', 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://east.sandbox.spade.com/batches/transactions/universal/enrich",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "OPTIONS",
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://east.sandbox.spade.com/batches/transactions/universal/enrich"

req, _ := http.NewRequest("OPTIONS", 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))

}
HttpResponse<String> response = Unirest.options("https://east.sandbox.spade.com/batches/transactions/universal/enrich")
.header("X-Api-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://east.sandbox.spade.com/batches/transactions/universal/enrich")

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

request = Net::HTTP::Options.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "name": "<string>",
  "description": "<string>",
  "renders": [
    "<string>"
  ],
  "parses": [
    "<string>"
  ],
  "synchronousMax": 123
}

Authorizations

X-Api-Key
string
header
required

Response

200 - application/json

Successful operation

name
string
required

The display name of the endpoint method.

Example:

"Post"

description
string
required

A short description of the endpoint.

Example:

"Enrich a list of universal transactions"

renders
string[]
required

Content types this endpoint can render.

Example:
["application/json"]
parses
string[]
required

Content types this endpoint can parse.

Example:
["application/json"]
synchronousMax
integer
required

The maximum number of items allowed in a single microbatch (?synchronous=true).

Example:

100