/subscribe

Adding a query

The /subscribe command sets up a new query in your private channel. A prompt will pop up to guide you through setting up a new subscription, which can be for listings, sales, collection floor-change or address . Address subscriptions are valid for both EOAs (externally owned addresses, AKA a user wallet) and contracts. The bot will ping your channel when a new activity matches your subscription!

List of every /subscribe option

Please note that collection slugs, trait names, and trait values must match OpenSea, Magic Eden or fx(hash) exactly. If you are unsure of what these should be:

/subscribe listings, sales & transfers

ERC-1155 batch listings/sales are skipped as the OpenSea API does not provide the necessary information.

Collection slug

Navigate to your collection of choice and pull from the end of the url:

• opensea.io/collection/collection-slug

• magiceden.io/marketplace/collection-slug

• fxhash.xyz/generative/slug/collection-slug

Example subscription for all Bored Ape Yacht Club listings under Ξ100

Trait names, values and ranges

• Trait names & values

Navigate to a token that has the traits you're looking for and copy exactly said trait name and trait value.

Example subscription for Bored Ape Yacht Club listings with trippy fur

It is possible to add multiple traits in a single alert using either an AND operator or an OR one: - Adding , in between each <trait>:<value> means that the NFT needs to have all of the traits for the alert to trigger. - Adding ; in between each <trait>:<value> means that the NFT needs to have at least one of the traits for the alert to trigger. It is also possible to use , and ; in a single query.

Example alert for all The Potatoz listings that have the poop element

The above example will trigger alerts for The Potatoz listings in 2 cases:

• If they have the poop element and are stage 5

• If they have the peach mutation and the vacuum pose traits

This is equivalent to having two separate alerts.

The input is case insensitive, meaning that capital letters do not matter and spaces are cropped out. fur:trippy is the same as Fur : TRIPPY for example.

It is possible to add several traits of the same property but different values. A valid example would be with CryptoPunks where most traits are under the accessory property, but will not work if you set fur:pink,fur:trippy on a BAYC alert since no NFT has both of those values. oSnipe equates ,to an AND operator while ; is an OR operator.

Wildcards (*) and exclusions (!) are possible with oSnipe: - traits: earring: * will ping for every BAYC listing that has earrings - traits: earring: !* will exclude every BAYC listing with earrings - traits: eyes: !crazy will exclude every BAYC listing with crazy eyes

• Ranges

It is possible to filter by a numerical range if an NFT or if the entire collection has one, an easy way to see if that is the case is to use /get-traits and see if any trait uses a range. An example of collection having a range would be the Sewer Pass or Gemesis rank, for a specific NFT we can look at environment/sediment tiers for Otherdeeds. To do so, simply input <range>: <min_value>-<max_value> within the traits option.

Subscription for all Gemesis listings with rank 1 to 1000

Subscription for all Otherdeeds with a Sediment Tier of 3 to 5

The full range must exist, i.e. if the top rank is 1, then traits: rank: 0-1000 will not work.

Price

You can choose a specific price in conjunction with other flags like traits and rarity for your alerts. You can either go with a minimum price, a maximum price or a % of the current floor price.

• min_price

Select the minimum price in Ether for which you would want the alert to trigger. This can for example be used in conjunction with other flags in order to have a better idea of liquidity for specific traits with sales.

Get notified for every MAYC sale above Ξ15

• max_price

Select the maximum price for which you would want the alert to trigger in Ether.

Note: If used in combination with max_floor_percentage, only events that are below your max_price and your max_floor_percentage will trigger an alert or snipe.

• max_floor_percentage

Select the maximum price for which you would want the alert to trigger in floor price percentage. You can specify a percentage of floor by adding a "%" at the end, i.e. max_floor_percentage: 120% will show you listings or sales that are less than 20% above floor. Conversely, max_floor_percentage: 80% will show you listings or sales that are more than 20% below floor.

If used in combination with max_price, only events that are below your max_price and your max_floor_percentage will trigger an alert or snipe.

Flagged Items

Allows users to skip flagged items on OpenSea by setting to True. Set to True by default.

Stop-Loss

Select the floor price for which to ignore listings (and therefore any attached snipes) under a given value in Ether. This is to prevent any unwanted sniping in case of a floor collapsing or just to stay within the desired margins and allow more granularity.

Any DeGods listings under Ξ3 will be skipped

Name

Allows users to give a nickname to the subscription.

Group

Allows users to create groups to facilitate the management of subscriptions.

Paused

Allows users to pause/unpause subscriptions.

Rarity

Allows users to choose a maximum rarity, alerts will trigger if any NFT with the specified rarity or lower (rarer) gets listed/sold. oSnipe uses OpenRarity as its rarity ranking.

It is possible to use the rarity option on collections that do not support OpenRarity yet but alerts will not trigger, they will only trigger once OpenRarity is available on said collection.

Token ID

Allows users to set up alerts for either specific token IDs or a range of token IDs. To subscribe to multiple, simply add a coma in between each ID.

Subscription for listings of Azukis #3, 88 to 222 & 5000. A listing of any of the following IDs will trigger an alert

Chain

The default value of this option is ETH, select SOL or XTZ in the case of a Solana or Tezos NFT query respectively.

Expirations

Allows users to set an expiration time on an alert, once an alert expires it will still show in /list but alerts/autosnipes will not trigger (they will have an [EXPIRED] tag to them). Expirations should be submitted in the format DD:HH:MM (days, hours, minutes). For example, a subscription meant to expire in 5 minutes should be 00:00:05. 5 days should be 05:00:00.

Example of an expired subscription and another that is valid for an hour

Additive ApeCoin Value Percentage

Users can set a percentage of apecoin value that the'd like to account for with subscriptions. For example: /subscribe listings collection-slug: boredapeyachtclub max_percentage_of_floor: 100 additive_apecoin_value_percent: 50 This would mean given a Ξ20 floor with $1000 per Ether, if an ape gets listed with 10k claimable ApeCoin, we will add 50% of the value to the max_price (let's assume ApeCoin is worth $1, we would add 50c per ApeCoin, $5,000 total, making max_price Ξ25). This is fully composable with any max_price or max_floor_percentage.

listingPrice <= (collectionFloor * percentageOfFloor) + (apecoinValueInEth * additiveApecoinValuePercentage)

Token

Allows users to set the currency in which they would like to value their subscriptions, the options are ETH (which is the default if not used), MATIC and USDC.

The listing token does not have to match subscription token. max_price: 5000, token: USDC will still match listings in ETH under $5000.

Webhook

Exclusive to Purveyor Pass holders, paste the webhook URL you wish to hook up alerts to. Full instructions in Purveyor.

Private transactions

Set the allow-private option to True to be notified by private transactions as well. The default value is False.

/subscribe floor-change

Input the collection slug and the target price that you would like to be alerted for, it can be above or below the current floor price. Once the alert hits, the subscription will delete itself.

• collection-slug

Collection slug of the desired NFT collection to be notified for.

• target

Target price that you want to be notified for in Ether.

• chain

Blockchain on which the subscribed collection resides.

/subscribe address

Paste the Ethereum address that you wish to follow in address. If no option is chosen apart from webhook and name, then every option will default to True. This means that alerts will trigger for every approval, listing, buy/sell and mint originating from the selected address. If a single option is set to True, every other one will default to False unless set to True individually. It is possible to follow contract addresses, in most instances the mint option would be used to follow the mint activity of a collection since other options might be to spammy, unless you're into those sort of things...

Address

The Ethereum address that should be monitored, the address can be a contract (for example the Mutant Ape Yacht Club for new mints).

Approvals

Set to True to receive alerts from setApprovalForAll.

Listings

Set to True to receive alerts from listings.

Sales

Set to True to receive alerts from buys & sells.

Mints

Set to True to receive alerts from mints.

Transfers

Set to True to receive alerts from transfers.

Webhook

Exclusive to Purveyor Pass holders. Paste the webhook URL you wish to use. Full instructions in Purveyor.

Name

Give a nickname to the associated address.

If no nickname is given and the address has a Primary ENS set, the ENS will be used as the nickname.