API reference

The Walker Street Data API is a REST API that takes a customer's bank transactions, classifies and enriches them, and turns them into decision-ready Insights. Every endpoint is listed in the sidebar, with its parameters, request and response schemas, code samples, and a panel to send a test request.

New here? Start with Get started or a recipe.

Base URLs

Environment	Base URL
Sandbox	https://sandbox.walkerstdata.com.au
Production	https://api.walkerstdata.com.au

Build and test against sandbox with your sandbox key, then switch to production and your production key when you go live.

Authentication

Send your API key in the x-api-key header on every request. A missing or invalid key returns 401; a valid key without the scope an endpoint needs returns 403. See Authentication.

cURL

curl "https://sandbox.walkerstdata.com.au/v1/jobs" \
  -H "x-api-key: YOUR_API_KEY"

Node.js

const resp = await fetch('https://sandbox.walkerstdata.com.au/v1/jobs', {
  headers: { 'x-api-key': process.env.WSD_API_KEY },
});
if (!resp.ok) throw new Error(`Request failed: ${resp.status}`);
const { data } = await resp.json();

Python

import os

import requests

resp = requests.get(
    "https://sandbox.walkerstdata.com.au/v1/jobs",
    headers={"x-api-key": os.environ["WSD_API_KEY"]},
)
resp.raise_for_status()
data = resp.json()["data"]

C#

using System.Net.Http.Json;
using System.Text.Json.Nodes;

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("WSD_API_KEY"));

var resp = await http.GetAsync("https://sandbox.walkerstdata.com.au/v1/jobs");
resp.EnsureSuccessStatusCode();
var data = (await resp.Content.ReadFromJsonAsync<JsonNode>())!["data"];

Responses

Every response is wrapped in the same envelope: data holds the payload on success, and message and errors describe what went wrong on failure. See Response formats.

{
  "data": { "customerId": "87d8e330-2878-4742-a86f-d1a1b1c65e1f" },
  "message": null,
  "errors": null
}

Downloads

• OpenAPI specification - the full contract, for generating clients or importing into other tools.
• Postman collection - every endpoint, ready to send.

Using the Postman collection

1. In Postman, choose Import and select the downloaded collection.
2. Open the collection's Variables tab and paste your key into sandboxApiKey (and productionApiKey when you have one).
3. Send requests. The collection calls sandbox by default; set the environment variable to production to switch both the base URL and the key.

Creating a customer or submitting transactions stores the returned customerId and jobId in collection variables, so the requests that follow pick them up automatically.