Skip to content
Asqary Docs

List the rule library

GET
/v1/rules
curl --request GET \
  --url https://api-staging.asqary.com/v1/rules \
  --header 'Authorization: Bearer <token>'

Rules, defaults and configurable parameters. Requires policies:read.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The rule library

Media typeapplication/json
object
engine_version
required
string
market
required
string
rules
required
Array<object>
object
code
required
string
version
required
integer
name
required
string
description
required
string
status
required
string
Allowed values: available coming_soon
inputs
required
Array<string>
default
required
object
enabled
boolean
weight
number
config
object
key
additional properties
any
config_schema
required
Array<object>
object
key
required
string
type
required
string
Allowed values: integer number string
min
number
max
number
unit
string
description
required
string
allowed
Array<string>

Example 

{
  "rules": [
    {
      "status": "available",
      "config_schema": [
        {
          "type": "integer"
        }
      ]
    }
  ]
}

401

Section titled “401”

Missing, invalid, expired or revoked API key.

Media typeapplication/json
object
error_code
required

Invalid_request, unauthorized, key_expired, key_revoked, forbidden, ip_not_allowed, quota_exceeded, not_found, method_not_allowed, conflict, policy_in_use, policy_active, policy_archived, idempotency_key_reused, validation_failed, rule_not_available, backtest_invalid_rows, backtest_too_large, rate_limited, internal_error

string
message
required
string
retryable
required
boolean
request_id
string
details
One of:
Array<object>
object
field
required
string
message
required
string
code
string

Example generated

{
  "error_code": "example",
  "message": "example",
  "retryable": true,
  "request_id": "example",
  "details": {}
}

403

Section titled “403”

Missing scope or role, IP not allowed, or monthly quota exceeded (quota_exceeded).

Media typeapplication/json
object
error_code
required

Invalid_request, unauthorized, key_expired, key_revoked, forbidden, ip_not_allowed, quota_exceeded, not_found, method_not_allowed, conflict, policy_in_use, policy_active, policy_archived, idempotency_key_reused, validation_failed, rule_not_available, backtest_invalid_rows, backtest_too_large, rate_limited, internal_error

string
message
required
string
retryable
required
boolean
request_id
string
details
One of:
Array<object>
object
field
required
string
message
required
string
code
string

Example generated

{
  "error_code": "example",
  "message": "example",
  "retryable": true,
  "request_id": "example",
  "details": {}
}