Skip to main content
POST
Generate Copula Samples

Authorizations

X-API-Key
string
header
required

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

Body

application/json
copula_type
enum<string>
required

Type of copula to use

Available options:
gaussian,
student_t,
clayton,
frank,
gumbel,
joe
Example:

"student_t"

correlation
number
default:0.5

Correlation parameter (for Gaussian/Student-t) or theta parameter (for Archimedean copulas)

Required range: -0.99 <= x <= 0.99
Example:

0.5

df
integer | null

Degrees of freedom for Student-t copula (required if copula_type is student_t)

Required range: x >= 2
Example:

5

n_samples
integer
default:1000

Number of samples to generate

Required range: x >= 100
Example:

1000

seed
integer | null

Random seed for reproducibility

Example:

42

Response

Copula samples generated successfully

success
boolean
Example:

true

data
object