curl --request POST \
  --url https://api.fincept.in/quantlib/physics/ising \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "size": 20,
  "J": 1,
  "h": 0,
  "temperature": 1.5,
  "n_steps": 5000,
  "seed": 42
}
'

{
  "success": true,
  "data": {
    "energy": -756,
    "magnetization": 0.842,
    "size": 20,
    "temperature": 1.5
  }
}

{
  "detail": "Invalid API key"
}

{
  "detail": "Insufficient credits. This endpoint requires 5 credits."
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

quantlib-physics

Simulate Ising Model

Simulates a 2D Ising model using Metropolis-Hastings Monte Carlo sampling. The Ising model describes interacting binary spins and exhibits phase transitions, making it useful for modeling collective behavior in financial systems, agent-based models, correlation structure, and systemic risk. Returns energy and magnetization of equilibrium configuration.

Use Cases:

Model herd behavior and market sentiment cascades
Study phase transitions in financial crises
Analyze correlation breakdown during stress
Agent-based market simulations
Systemic risk and contagion modeling

Formula: E = -J Σ s_i s_j - h Σ s_i (spins s_i = ±1)

Credits: 5 credits per request (Pro Tier) [Tier: ENTERPRISE, Credits: 10]

POST

quantlib

physics

ising

curl --request POST \
  --url https://api.fincept.in/quantlib/physics/ising \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "size": 20,
  "J": 1,
  "h": 0,
  "temperature": 1.5,
  "n_steps": 5000,
  "seed": 42
}
'

{
  "success": true,
  "data": {
    "energy": -756,
    "magnetization": 0.842,
    "size": 20,
    "temperature": 1.5
  }
}

{
  "detail": "Invalid API key"
}

{
  "detail": "Insufficient credits. This endpoint requires 5 credits."
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key

string

header

required

API key for authentication. Get your key at https://api.fincept.in/auth/register

Body

application/json

size

integer

default:10

Grid size (creates size × size lattice)

Example:

20

number

default:1

Coupling constant (J>0: ferromagnetic/positive correlation, J<0: antiferromagnetic)

Example:

1

number

default:0

External field (bias toward +1 or -1 spins)

Example:

0

temperature

number

default:2

Temperature (T<Tc: ordered phase, T>Tc: disordered phase, Tc≈2.27 for J=1)

Example:

2.5

n_steps

integer

default:1000

Number of Monte Carlo steps for equilibration

Example:

5000

seed

integer | null

Random seed for reproducibility (optional)

Example:

42

Response

Ising model simulation completed successfully

success

boolean

Example:

true

data

object

Show child attributes

Free Tier (0 credits)

Basic Tier (1 credit)

Standard Tier (2 credits)

Pro Tier (5 credits)

Enterprise Tier (10 credits)

Simulate Ising Model

Authorizations

Body

Response