OpenFinex configuration

OpenFinex configuration is stored in config/config.yaml.

Gateway orders create rate limits

Different rate limits can be applied for orders creation depending on users role.

This is configured in the section gateway.rate.

Note: It is not an API rate limit mechanism.

gateway:
  rate:
    maker:
      - limit: 500
        period: 10s
    default:
      - limit: 50
        period: 10s
      - limit: 10000
        period: 24h

The only mandatory role is default, this is the default configuration applied if a role doesn't have explicit settings.

  • role - user role defined in barong.
  • config - list of limit-period pairs. So it limits to Not more than {limit} requests per {period}.

API request rate limits

Finex also has API-level rate limiter. The configuration is stored in config/config.yaml in the section api.rate.

api:
  rate:
    maker:
      limit: 500
      period: 10s
    default:
      limit: 500
      period: 10s

It works similarly to the gateway orders create rate limits, but supports only one limit per role.

Bulk API limits

The maximum number of orders contained in bulk create/cancel order API request can be configured by the entry api.bulk_limit.

api:
  bulk_limit: 100

Restrict features access

You can limit openfinex feature access to users with a specific role and a minimum KyC level. This is configure in the section api.actions.

The following configuration limits the bulk API endpoints to be accessed only by users with the role maker and a minimum of KyC level 3, regular trading endpoints (single order create, cancel) are allowed to other roles with a minimum KyC level 2.

api:
  actions:
    trade:
      min_level: 2
      roles: [member, broker, trader, maker]
    bulk_api:
      min_level: 3
      roles: [maker]