Connect to the Aurato Graph.

Build applications and integrate Aurato data into your workflows with through predictable REST endpoints.

Getting started

Your first API request in three steps:

1
Create your Aurato account
Loading your account…
2
Create & copy your API key
Create a key in Account → Tokens → Keys, and copy it when it appears (only shown once).
3
Send the Bearer header
Call the HTTPS base URL with
Authorization: Bearer AURATO_API_KEY.

curl --request GET \
  --url 'https://api.aurato.io/v1/markets?page[size]=5' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer AURATO_API_KEY'

const response = await fetch(
  "https://api.aurato.io/v1/payment-methods/pix?include=measurements,sources",
  {
    headers: {
      Accept: "application/json",
      Authorization: "Bearer " + process.env.AURATO_API_KEY,
    },
  },
);

if (!response.ok) {
  const problem = await response.json();
  throw new Error(problem.code + ": " + problem.detail);
}

const { data, meta } = await response.json();

import os
import requests

response = requests.get(
    "https://api.aurato.io/v1/markets/netherlands/payment-methods",
    headers={
        "Accept": "application/json",
        "Authorization": f"Bearer {os.environ['AURATO_API_KEY']}",
    },
    timeout=30,
)
response.raise_for_status()

payload = response.json()
print(payload["meta"]["count"])

Authentication

Every data request uses an account-owned Aurato API Key with Bearer authentication.

Base URLhttps://api.aurato.io

AuthorizationBearer aurato_…

Required scopegraph:read

TransportHTTPS only

Endpoint reference

The Aurato API is a read-only RESTful service, all paths support GET and CORS preflight through OPTIONS.

Main endpoints

The complete live v1 surface, including discovery, collections, records and identifier lookups.

72 endpoints

Method	Path	Returns	Auth
GET	`/v1`	API discovery document	Public
GET	`/v1/health`	Service health and API version	Public
GET	`/v1/markets`	List and filter markets	Key
GET	`/v1/markets/{id-or-slug}`	Retrieve one markets record	Key
GET	`/v1/markets/{id-or-slug}/relationships`	Typed links to connected Graph records	Key
GET	`/v1/markets/{id-or-slug}/measurements`	Structured observations for the record	Key
GET	`/v1/markets/{id-or-slug}/sources`	Sources supporting the record	Key
GET	`/v1/payment-methods`	List and filter payment methods	Key
GET	`/v1/payment-methods/{id-or-slug}`	Retrieve one payment methods record	Key
GET	`/v1/payment-methods/{id-or-slug}/relationships`	Typed links to connected Graph records	Key
GET	`/v1/payment-methods/{id-or-slug}/measurements`	Structured observations for the record	Key
GET	`/v1/payment-methods/{id-or-slug}/sources`	Sources supporting the record	Key
GET	`/v1/currencies`	List and filter currencies	Key
GET	`/v1/currencies/{id-or-slug}`	Retrieve one currencies record	Key
GET	`/v1/currencies/{id-or-slug}/relationships`	Typed links to connected Graph records	Key
GET	`/v1/currencies/{id-or-slug}/measurements`	Structured observations for the record	Key
GET	`/v1/currencies/{id-or-slug}/sources`	Sources supporting the record	Key
GET	`/v1/schemes`	List and filter schemes	Key
GET	`/v1/schemes/{id-or-slug}`	Retrieve one schemes record	Key
GET	`/v1/schemes/{id-or-slug}/relationships`	Typed links to connected Graph records	Key
GET	`/v1/schemes/{id-or-slug}/measurements`	Structured observations for the record	Key
GET	`/v1/schemes/{id-or-slug}/sources`	Sources supporting the record	Key
GET	`/v1/systems`	List and filter payment and card systems	Key
GET	`/v1/systems/{id-or-slug}`	Retrieve one payment and card systems record	Key
GET	`/v1/systems/{id-or-slug}/relationships`	Typed links to connected Graph records	Key
GET	`/v1/systems/{id-or-slug}/measurements`	Structured observations for the record	Key
GET	`/v1/systems/{id-or-slug}/sources`	Sources supporting the record	Key
GET	`/v1/operators`	List and filter operators	Key
GET	`/v1/operators/{id-or-slug}`	Retrieve one operators record	Key
GET	`/v1/operators/{id-or-slug}/relationships`	Typed links to connected Graph records	Key
GET	`/v1/operators/{id-or-slug}/measurements`	Structured observations for the record	Key
GET	`/v1/operators/{id-or-slug}/sources`	Sources supporting the record	Key
GET	`/v1/psps`	List and filter payment service providers	Key
GET	`/v1/psps/{id-or-slug}`	Retrieve one payment service providers record	Key
GET	`/v1/psps/{id-or-slug}/relationships`	Typed links to connected Graph records	Key
GET	`/v1/psps/{id-or-slug}/measurements`	Structured observations for the record	Key
GET	`/v1/psps/{id-or-slug}/sources`	Sources supporting the record	Key
GET	`/v1/banks`	List and filter banks	Key
GET	`/v1/banks/{id-or-slug}`	Retrieve one banks record	Key
GET	`/v1/banks/{id-or-slug}/relationships`	Typed links to connected Graph records	Key
GET	`/v1/banks/{id-or-slug}/measurements`	Structured observations for the record	Key
GET	`/v1/banks/{id-or-slug}/sources`	Sources supporting the record	Key
GET	`/v1/regulators`	List and filter regulators	Key
GET	`/v1/regulators/{id-or-slug}`	Retrieve one regulators record	Key
GET	`/v1/regulators/{id-or-slug}/relationships`	Typed links to connected Graph records	Key
GET	`/v1/regulators/{id-or-slug}/measurements`	Structured observations for the record	Key
GET	`/v1/regulators/{id-or-slug}/sources`	Sources supporting the record	Key
GET	`/v1/regulations`	List and filter compliance and regulatory records	Key
GET	`/v1/regulations/{id-or-slug}`	Retrieve one compliance and regulatory records record	Key
GET	`/v1/regulations/{id-or-slug}/relationships`	Typed links to connected Graph records	Key
GET	`/v1/regulations/{id-or-slug}/measurements`	Structured observations for the record	Key
GET	`/v1/regulations/{id-or-slug}/sources`	Sources supporting the record	Key
GET	`/v1/standards`	List and filter payments standards	Key
GET	`/v1/standards/{id-or-slug}`	Retrieve one payments standards record	Key
GET	`/v1/standards/{id-or-slug}/relationships`	Typed links to connected Graph records	Key
GET	`/v1/standards/{id-or-slug}/measurements`	Structured observations for the record	Key
GET	`/v1/standards/{id-or-slug}/sources`	Sources supporting the record	Key
GET	`/v1/markets/{id-or-slug}/payment-methods`	Payment methods available in a market	Key
GET	`/v1/markets/{id-or-slug}/scheme-profile`	Latest annual Schemes profile, breakdowns and detail panels	Key
GET	`/v1/markets/{id-or-slug}/scheme-volume-history`	Annual scheme transaction history for 2015–2025	Key
GET	`/v1/payment-methods/{id-or-slug}/markets`	Markets connected to a payment method	Key
GET	`/v1/cards`	List and filter card products	Key
GET	`/v1/cards/{id-or-slug}`	Retrieve one card product	Key
GET	`/v1/iin`	List public IIN / BIN ranges	Key
GET	`/v1/iin/{value}`	Look up the first 6–11 card digits	Key
GET	`/v1/bic`	List public BIC / SWIFT records	Key
GET	`/v1/bic/{value}`	Look up an 8- or 11-character BIC	Key
GET	`/v1/mcc`	List canonical merchant category codes	Key
GET	`/v1/mcc/{value}`	Look up an MCC and its code-set variants	Key
GET	`/v1/bsc`	List clearing-system member codes	Key
GET	`/v1/bsc/{value}`	Look up a code with automatic system detection	Key
GET	`/v1/bsc/{system}/{value}`	Look up ABA, Sort Code, BSB, IFSC or BLZ	Key

Markets

Browse payment landscapes or resolve one market by permanent Aurato ID or readable slug.

6 endpoints

GET/v1/markets

Paginated market collection.

GET/v1/markets/{id-or-slug}

Canonical market record.

GET/v1/markets/{id-or-slug}/payment-methods

Methods linked through available_in. Contextual method measurements use the selected market.

GET/v1/markets/{id-or-slug}/relationships

All typed Graph relationships.

GET/v1/markets/{id-or-slug}/measurements

Market observations and paginated monthly method history.

GET/v1/markets/{id-or-slug}/sources

Supporting source registry entries.

Payment Methods

Browse branded ways to pay or resolve one method by permanent Aurato ID or readable slug.

6 endpoints

GET/v1/payment-methods

Paginated payment-method collection.

GET/v1/payment-methods/{id-or-slug}

Canonical payment-method record.

GET/v1/payment-methods/{id-or-slug}/markets

Markets connected through available_in.

GET/v1/payment-methods/{id-or-slug}/relationships

All typed Graph relationships.

GET/v1/payment-methods/{id-or-slug}/measurements

Method observations and paginated monthly market history.

GET/v1/payment-methods/{id-or-slug}/sources

Supporting source registry entries.

Payment infrastructure

Currencies, schemes, technical systems, operators, PSPs, banks and regulators use the same stable entity contract.

9 endpoints

GET/v1/currencies

Currencies; records also expose /relationships, /measurements and /sources.

GET/v1/schemes

Payment schemes and their connected methods, systems and markets.

GET/v1/systems

Payment rails, payment systems and card systems.

GET/v1/operators

Organizations operating payment infrastructure.

GET/v1/psps

Payment service providers and supported methods.

GET/v1/banks

Banks and their connected market and card context.

GET/v1/regulators

Regulatory authorities and linked jurisdictions.

GET/v1/{collection}/{id-or-slug}/relationships

Universal typed relationship subresource. Replace {collection} with any entity collection above.

GET/v1/{collection}/{id-or-slug}/{linked-collection}

Convenience view of linked records. For example /v1/schemes/{id-or-slug}/payment-methods.

Governance

Source-backed rules and reference material are separated by developer intent, while using the same canonical response envelope.

4 endpoints

GET/v1/regulations

Regulations, sanctions lists and compliance requirements.

GET/v1/standards

Payment, security and messaging standards.

GET/v1/regulations/{id-or-slug}

One compliance or regulatory record.

GET/v1/standards/{id-or-slug}

One standard.

Cards

Cards is a dedicated product dataset rather than an Atlas entity collection, but follows the same response and pagination conventions.

2 endpoints

GET/v1/cards

Paginated card-product collection with market, audience, type and network filters.

GET/v1/cards/{id-or-slug}

Full card attributes and optional linked Graph records.

Identifier lookups

IIN, BIC, MCC and BSC are separate singular modules. Their natural code is the lookup key.

9 endpoints

GET/v1/iin

Paginated public IIN / BIN range collection.

GET/v1/iin/{value}

Best matching range for a 6–11 digit prefix.

GET/v1/bic

Paginated public BIC / SWIFT collection.

GET/v1/bic/{value}

Normalized 8- or 11-character BIC lookup.

GET/v1/mcc

Canonical merchant category codes.

GET/v1/mcc/{value}

Canonical MCC plus available ISO and network variants.

GET/v1/bsc

Bank and clearing-system member-code collection.

GET/v1/bsc/{value}

Automatic clearing-system detection.

GET/v1/bsc/{system}/{value}

Explicit system lookup. Systems: aba, sort-code, bsb, ifsc and blz.

OpenAPI 3.2 Specs

Querying collections

Use documented parameters only; Aurato deliberately does not expose free-form database queries.

Main Collections

Shared search, filtering, include, sorting and cursor parameters for the core entity collections.

Parameter	Available on	Behavior
q	Collections	Text search across names and indexed record content.
filter[market]	Payment Methods	Filter by market ID, slug or name, for example netherlands.
filter[region]	Collections	Filter by an exact Aurato region value.
filter[type]	Payment Methods	Filter by payment-method type, for example Wallet.
filter[use_case]	Payment Methods	Filter by an exact use case.
filter[channel]	Payment Methods	Filter by an exact channel.
filter[payment_method]	Infrastructure	Filter schemes, systems, operators or PSPs by a connected method.
filter[category]	Governance	Filter regulations or standards by category.
filter[audience]	Cards	Filter by card audience.
filter[network]	Cards	Filter by card network family.
filter[market] / filter[issuer]	IIN, BIC & BSC	Filter by a permanent linked Aurato ID such as mkt_nl or bnk_ing.
filter[country]	IIN, BIC & BSC	Filter by an ISO alpha-2 country code.
filter[scheme] / filter[funding_type]	IIN	Filter IIN / BIN ranges by scheme or funding type.
filter[system]	BSC	Filter by aba, sort-code, bsb, ifsc or blz.
filter[code_set]	MCC lookup	Choose ISO legacy, Visa, Mastercard or American Express variants.
include	Collections + records	Comma-separated: relationships, measurements, sources.
sort	Entity collections	name, -name, updated_at or -updated_at. Cards supports name; identifiers support code or updated_at.
page[size]	Collections	Records per page. Default 50; minimum 1; maximum 200.
page[after]	Collections	Opaque cursor from meta.page.after or links.next.

GET /v1/payment-methods?q=pay&filter[market]=netherlands&filter[type]=Wallet&include=measurements,sources&sort=-updated_at&page[size]=25 HTTP/1.1
Host: api.aurato.io
Accept: application/json
Authorization: Bearer aurato_YOUR_KEY

Cards

Product-specific filters in the standard collection envelope, with links to markets, payment methods, banks and providers.

GET /v1/cards?filter[market]=netherlands&filter[network]=Mastercard&page[size]=25

GET /v1/cards/crd_nl-abn-amro-abn-amro-debit-mastercard?include=relationships

Identifiers

Singular lookup paths that normalize safe formatting such as spaces, hyphens and lowercase BIC input.

GET /v1/iin/424242
GET /v1/bic/INGBNL2A
GET /v1/mcc/5411?filter[code_set]=visa_2024_04
GET /v1/bsc/sort-code/200000

Pagination

Collection results are stable, bounded pages. Treat cursors as opaque and follow links.next.

Default page size: 50
Maximum page size: 200
The cursor is tied to its collection and sort order.
A null links.next means there are no more records.
Changing the sort requires restarting without a cursor.
meta.page.total is null for large identifier datasets to keep requests fast; use has_more and links.next.

{
  "data": [/* records */],
  "links": {
    "self": "https://api.aurato.io/v1/markets?page[size]=50",
    "next": "https://api.aurato.io/v1/markets?page[size]=50&page[after]=eyJ..."
  },
  "meta": {
    "page": {
      "size": 50,
      "returned": 50,
      "total": 252,
      "has_more": true,
      "after": "eyJ..."
    }
  }
}

Response model

Every successful response uses the same top-level envelope: data, links and meta.

Canonical records

Records expose permanent identity, typed attributes, human-readable descriptions, canonical links and dataset metadata. Optional relationships, measurements and sources appear only when requested with include.

data: One record, a collection or a subresource list.
links: Canonical self and pagination URLs.
meta: Contract, ontology, release, rule and request identifiers.

{
  "data": {
    "id": "pmt_pix",
    "type": "payment_method",
    "slug": "pix",
    "name": "Pix",
    "short_name": "Pix",
    "description": "Brazil's instant account-to-account payment method.",
    "summary": "Instant payments in Brazil.",
    "aliases": [],
    "attributes": {
      "type": "A2A"
    },
    "updated_at": "2026-09-01T18:42:00Z",
    "links": {
      "self": "https://api.aurato.io/v1/payment-methods/pmt_pix",
      "measurements": "https://api.aurato.io/v1/payment-methods/pmt_pix/measurements",
      "sources": "https://api.aurato.io/v1/payment-methods/pmt_pix/sources",
      "markets": "https://api.aurato.io/v1/payment-methods/pmt_pix/markets"
    }
  },
  "links": {
    "self": "https://api.aurato.io/v1/payment-methods/pmt_pix"
  },
  "meta": {
    "api_version": "1",
    "ontology_version": "2026-09",
    "dataset_release": "live",
    "rule_version": "2026-09.1",
    "request_id": "req_01..."
  }
}

Relationships, measurements, and sources

Keep default records compact, then request the evidence and connections your application needs.

relationships

Connected records

Directional, typed links with a target ID, type, slug, name, canonical URL and source IDs.

measurements

Structured observations

Numeric values are returned as strings, alongside units, display values, periods, methods, and confidence.

sources

Supporting evidence

Source IDs, titles, publishers, canonical URLs, jurisdictions and retrieval timestamps.

Include in the record

Use a comma-separated list when you prefer one expanded response:

?include=relationships,measurements,sources

Fetch separately

Use nested endpoints when the app needs smaller payloads.

/v1/payment-methods/pmt_pix/sources

{
  "metric": "transactions",
  "value": "1560000000",
  "unit": "transactions",
  "display_value": "1.56B",
  "period": { "label": "2025" },
  "method": "reported",
  "confidence": { "score": 92, "level": "high" },
  "methodology": null,
  "source_ids": ["src_01..."]
}

Monthly history (from August 2016)

Set period_basis=calendar_month on a market or payment method's measurements endpoint to read the published method-by-market observations for users, transactions and TPV. Filter by market ID, metric or inclusive month range. Continue with links.next or meta.page.next_offset, keeping the filters unchanged. Each row retains its month, unit, confidence, observation, and source IDs. An absent month means no published observation, not zero.

GET /v1/markets/mkt_nl/measurements?period_basis=calendar_month&filter[metric]=users&filter[from]=2016-08&page[size]=100

GET /v1/payment-methods/pmt_pix/measurements?period_basis=calendar_month&filter[context_id]=mkt_br&filter[from]=2016-08&page[size]=100&page[offset]=100

Headers

Standard headers make requests traceable and safe to integrate across server environments.

Request headers

Authorization: Bearer API key; required for data.
Accept: application/json or */*.
If-None-Match: Conditional request using a prior ETag.

Response headers

X-Request-Id: Reference for debugging and support.
X-Aurato-API-Version: Current HTTP contract version.
X-Aurato-Dataset-Release: Dataset release used for the response.
X-Aurato-Key-Id: Safe internal identifier for the calling key.
X-Aurato-Plan: Plan attached to the account.
X-Aurato-Units-Used: Units recorded for the request; currently 1.
ETag: Weak validator for conditional requests.

Errors

Failures use application/problem+json with a stable machine-readable code and request ID.

Status	Code	Meaning
400	INVALID_INCLUDE	The include list contains an unsupported value.
400	INVALID_PAGE_SIZE	page[size] is outside the supported 1–200 range.
400	INVALID_CURSOR	The cursor is invalid or belongs to another collection or sort order.
400	INVALID_SORT	The requested sort field is not supported.
400	INVALID_IIN / BIC / MCC / BSC	The natural identifier has an invalid format.
400	INVALID_CODE_TYPE	The requested clearing-code system is not supported.
400	INVALID_CODE_SET	The requested MCC code set is not available.
401	AUTHENTICATION_REQUIRED	The Authorization header is missing.
401	INVALID_API_KEY	The key is malformed, unknown, expired or revoked.
403	INSUFFICIENT_SCOPE	The key does not include graph:read.
404	COLLECTION_NOT_FOUND	The requested top-level collection is not available in v1.
404	MARKET_NOT_FOUND	A market supplied as a filter does not exist.
404	RESOURCE_NOT_FOUND	No record matches the supplied ID or slug.
404	SUBRESOURCE_NOT_FOUND	The requested nested resource is not supported.
406	NOT_ACCEPTABLE	The Accept header requests a representation not available in the current v1.
503	DATASET_UNAVAILABLE	The live canonical dataset could not be loaded completely.
503	AUTHENTICATION_UNAVAILABLE	API-key verification is temporarily unavailable.
503	LOOKUP_UNAVAILABLE	The requested identifier lookup is temporarily unavailable.
503	SERVICE_UNAVAILABLE	The requested Graph operation is temporarily unavailable.

{
  "type": "https://api.aurato.io/problems/invalid-api-key",
  "title": "Invalid Api Key",
  "status": 401,
  "detail": "The supplied Aurato API key is invalid, expired or revoked",
  "instance": "/v1/markets",
  "code": "INVALID_API_KEY",
  "request_id": "req_01..."
}

Versioning

API changes and data changes are versioned independently.

/v1

API version

Changes only for a breaking HTTP contract change.

ontology_version

Definitions

Identifies the vocabulary used in the response.

dataset_release

Data release

Identifies the current updated Aurato Graph dataset.

rule_version

Graph logic

Identifies normalization, resolution and derivation.

Help

Find guidance, answers to frequently asked questions, or contact the Aurato team.

SupportGet in touch for info or support with your integration.FAQFind answers to common questions about the API.HelpBrowse Aurato guidance, definitions, and taxonomy.

Status Health

Benefits comparison for Basic, Premium and Pro subscriptions
Benefits		Premium	Pro
Benefits		$49	$99
API/MCP Key
Favorites
Show More	20	All	All
BIN/INN+
PSP Data
Card Data
Dashboard
Workbench
AMS
Tokens		100	250
Help Contact

Connect to the Aurato Graph.

Your first API request in three steps:

Create your Aurato account

Create & copy your API key

Send the Bearer header

Authentication

Endpoint reference

Main endpoints

Markets

Payment Methods

Payment infrastructure

Governance

Cards

Identifier lookups

Querying collections

Main Collections

Cards

Identifiers

Pagination

Response model

Canonical records

Relationships, measurements, and sources

Connected records

Structured observations

Supporting evidence

Include in the record

Fetch separately

Monthly history (from August 2016)

Headers

Request headers

Response headers

Errors

Versioning

API version

Definitions

Data release

Graph logic

Help