Skip to main content
POST
/
generic
/
data
/
generate
/
finance
Generate synthetic finance data
curl --request POST \
  --url https://apix.spotzee.com/api/ext/generic/data/generate/finance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data count=10 \
  --data locale=en \
  --data seed=12345 \
  --data method=profile \
  --data accountNumberLength=8 \
  --data amountMin=0 \
  --data amountMax=1000 \
  --data amountDecimalPlaces=2 \
  --data 'amountSymbol=$' \
  --data amountAutoFormat=false \
  --data bicIncludeBranchCode=false \
  --data bitcoinAddressType=bech32 \
  --data bitcoinNetwork=testnet \
  --data creditCardIssuer=visa \
  --data ibanFormatted=false \
  --data ibanCountryCode=DE \
  --data maskedNumberLength=4 \
  --data maskedNumberParens=true \
  --data maskedNumberEllipsis=true \
  --data pinLength=4
{
  "status": "success",
  "data": {
    "finance": [
      {
        "method": "profile",
        "value": "Personal Loan Account",
        "accountName": "Personal Loan Account",
        "accountNumber": "92842238",
        "accountNumberLength": 8,
        "amount": "$617.87",
        "amountMin": 0,
        "amountMax": 1000,
        "amountDecimalPlaces": 2,
        "amountSymbol": "$",
        "amountAutoFormat": false,
        "currency": {
          "code": "USD",
          "name": "US Dollar",
          "symbol": "$",
          "numericCode": "840"
        },
        "currencyCode": "USD",
        "currencyName": "US Dollar",
        "currencyNumericCode": "840",
        "currencySymbol": "$",
        "bic": "WYAUPGX1",
        "bicIncludeBranchCode": false,
        "iban": "DE84 1022 7075 0900 1170 01",
        "ibanFormatted": true,
        "ibanCountryCode": "DE",
        "routingNumber": "522814402",
        "maskedNumber": "(...9711)",
        "maskedNumberLength": 4,
        "maskedNumberParens": true,
        "maskedNumberEllipsis": true,
        "transactionDescription": "payment transaction using a masked fixture for USD 617.87",
        "transactionType": "payment"
      }
    ],
    "generated": 1,
    "locale": "en",
    "seed": 12345,
    "method": "profile"
  },
  "performance": {
    "generationTime": 2,
    "itemsGenerated": 1,
    "locale": "en"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token authentication. Use format: Bearer YOUR_API_KEY

Body

application/x-www-form-urlencoded
​
count
string

Number of finance records to generate (1-100). Passed as string but must be numeric.

Pattern: ^[1-9]\d?$|^100$
Example:

"10"

​
locale
string

Locale for generated data (e.g., en, es, fr, de, pt_BR, zh_CN)

Example:

"en"

​
seed
string

Seed for deterministic generation. Same seed produces same results.

Example:

"12345"

​
method
enum<string>

Finance generation method. Defaults to profile.

Available options:
profile,
accountName,
accountNumber,
amount,
bic,
bitcoinAddress,
creditCardCVV,
creditCardIssuer,
creditCardNumber,
currency,
currencyCode,
currencyName,
currencyNumericCode,
currencySymbol,
ethereumAddress,
iban,
litecoinAddress,
maskedNumber,
pin,
routingNumber,
transactionDescription,
transactionType
Example:

"profile"

​
accountNumberLength
string

Generated account-number length. Defaults to 8.

Pattern: ^[1-9]\d*$
Example:

"8"

​
amountMin
string

Minimum generated amount when method=amount or profile. Defaults to 0.

Pattern: ^-?(?:\d+|\d*\.\d+)$
Example:

"0"

​
amountMax
string

Maximum generated amount when method=amount or profile. Defaults to 1000.

Pattern: ^-?(?:\d+|\d*\.\d+)$
Example:

"1000"

​
amountDecimalPlaces
string

Number of decimal places for generated amounts when method=amount or profile. Defaults to 2.

Pattern: ^\d+$
Example:

"2"

​
amountSymbol
string

Optional currency symbol or prefix for generated amounts. Maximum 8 characters.

Maximum string length: 8
Example:

"$"

​
amountAutoFormat
enum<string>

Use locale-aware amount formatting when supported.

Available options:
true,
false
Example:

"false"

​
bicIncludeBranchCode
enum<string>

Include a branch code on generated BIC values.

Available options:
true,
false
Example:

"false"

​
bitcoinAddressType
enum<string>

Bitcoin address family when method=bitcoinAddress.

Available options:
legacy,
segwit,
bech32,
taproot
Example:

"bech32"

​
bitcoinNetwork
enum<string>

Bitcoin network when method=bitcoinAddress. Defaults to mainnet.

Available options:
mainnet,
testnet
Example:

"testnet"

​
creditCardIssuer
string

Optional card issuer or safe fixture format when method=creditCardNumber. Maximum 64 printable ASCII characters.

Maximum string length: 64
Example:

"visa"

​
ibanFormatted
enum<string>

Return formatted IBAN output when method=iban or profile.

Available options:
true,
false
Example:

"false"

​
ibanCountryCode
string

Optional two-letter uppercase country code for generated IBAN values.

Pattern: ^[A-Z]{2}$
Example:

"DE"

​
maskedNumberLength
string

Length of the unmasked suffix for generated masked numbers. Defaults to 4.

Pattern: ^[1-9]\d*$
Example:

"4"

​
maskedNumberParens
enum<string>

Wrap generated masked numbers in parentheses.

Available options:
true,
false
Example:

"true"

​
maskedNumberEllipsis
enum<string>

Prefix generated masked numbers with an ellipsis.

Available options:
true,
false
Example:

"true"

​
pinLength
string

Generated PIN length. Defaults to 4.

Pattern: ^[1-9]\d*$
Example:

"4"

Response

Successfully generated finance data

​
status
enum<string>
required
Available options:
success
​
data
object
required
​
performance
object