BAQL Version 1.0.0

Abstract

BAQL (Bot Assistant Query Language) is a domain specific language used for expressing declarative requirements for Bot Assistant engines used in automated trading systems.

Its goal is to provide a flexible and ergonomic semantic to users and a machine parseable set of instructions that can be used to query for the requested data.

It’s designed to be platform agnostic, albeit some expressions might not be available in all dialects.

Syntax

The syntax of the language is currently maintained by The Trading Parrot community and it’s subject to evolution over time. It follows the rules of semantic versioning.

Queries are implicit assumed as part of the language, therefore it’s not required to have explicit imperative clauses.

Language Elements

• One sentence
• Prefix required to start the sentence
• One or more actions are allowed in the sentence separated by space
• Each action contains one operator and a predicate
• No spaces allowed within the action
• Each predicate is dependent of the operator
• Only one action per operator is allowed
• The maximum length of a valid BAQL query is limited to 500 characters, including the ignored ones
• The numbers are natural numbers with a hard limit to 100000

Operators

Each action contains an operator and a predicate. Each operator comes with its own rules (criteria) but all of them should complain about the restrictions of BAQL grammar and syntax. The operators should be extensible and independent one each other.

Pairs Settings

Operator to command changes to the pairs settings of a bot.

PS Operator name

• Two criterias
  • Categories
  • Sort

Grammar

Here is the EBNF-like grammar of the BAQL. The spaces in the grammar definition are for human readability. The grammar described here isn’t meant to be 100% accurate. Here are some missing details:

• Numbers are expressed as regular expression to simplify their definition here
• Usage of quantifiers like ()* and ()+ to simplify the expression of occurrences

Main

sentence: prefix actions

actions: action ((action_separator)+ action)*

prefix: 'BAQL:'

action_separator: ' '

action: operator 
      | operator operator_separator predicate

operator: 'PS'

operator_separator: ':'

PairsSettings Operator

predicate: categories criteria_separator sort

categories: 'ALL'
          | category_list

category_list: category (category_separator category)*

category: 'DEFI'
        | 'ERC'
        | 'NFT'
        | 'DOT'
        | 'BSC'
        | 'ZIL'
        | 'MEME'
        | 'SC'

category_separator: '&'

criteria_separator: '_'

sort: criteria_separator sort_number criteria_separator sort_keyword reverse_keyword

sort_number: [0-9]+
               
sort_keyword: 'LCGS'
            | 'LCAR'
            | 'DUSD'
            | 'DBTC'
            | 'HUSD'
            | 'SV'
            | 'BES'
            | 'BUS'
            | 'MC'
            | 'MV'

reverse_keyword: '.r'
               | ''
          

Sort keywords:

Sort Name	Description	Default Sort Order
LCGS	LunarCrush Galaxy Scoretm	descending
LCAR	LunarCrush AltRanktm	ascending
DUSD	24h % change (USD)	descending
DBTC	24h % change (BTC)	descending
HUSD	1h % Change (USD)	descending
SV	Social Volume	descending
BUS	Bullish Sentiment	descending
BES	Bearish Sentiment	descending
MC	Market cap	descending
MV	Market volume	descending

Supported categories:

Category	Description
DEFI	DeFi
ERC	ERC-20
NFT	NFT
DOT	DOT ecosystem
BSC	BSC ecosystem
ZIL	ZIL ecosystem
SC	Stable coins
MEME	Meme coins

Examples

❌ ALL_50_BUS

INVALID: Missing starting BAQL tag

❌ BAQL:ALL_50BUS

INVALID: No available actions

❌ BAQL:XXX:ALL_50BUS

INVALID: No available actions

PairsSettings Operator

✅ BAQL:PS:ALL_50_BUS

• All categories
• Top 50 tokens sorted by bullish sentiment

✅ BAQL:PS:MEME_25_DUSD

• Meme category
• Top 25 coins with highest daily %change in USD

✅ BAQL:PS:ALL_200_MC.r

• All categories
• Lowest 200 market cap tokens

✅ BAQL:PS:DEFI&NFT_25_DBTC

• Categories: DeFi & NFT
• Top 25 coins with daily % change in BTC

✅ BAQL:PS:ALL_10_LCAR

• All categories
• Top 10 altrank coins

❌ BAQL:PS:ALL_10_ZZ

INVALID: PS: Invalid sorting order keyword

❌ BAQL:PS:ALL_LCAR

INVALID: PS: action malformed

Comments

Comments are not allowed in BAQL.

Appendixes

Error codes

Code	Meaning
1001	String too long: Max 500 chars
1002	Missing starting BAQL tag
1003	Additional start tags
2001	No available actions
2002	Unsupported action
2003	Multiple occurences of the same action
3001	PS: action malformed
3002	PS: Unsupported categories
3003	PS: Invalid n. of tokens [1,99999]
3004	PS: Invalid sorting criteria
3005	PS: Invalid sorting order keyword

---

Notes

• ^{_{GalaxyScore™️ and AltRank™️ are registered trademarks of LunarCrush Inc..}}