{"openapi":"3.1.0","info":{"title":"ArbTide API","description":"Live crypto funding rates and price arbitrage across 35 CEX and perp DEX exchanges, net of fees: spot and futures spreads, funding gaps and carry trades. Every call needs an API key and costs credits (see x-credits on each operation). Free: 100 credits a UTC day at 1 a second. Pro: 5,000,000 a UTC month at 50 a second.","version":"1.0.0"},"servers":[{"url":"https://arbtide.com"}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"An arb_ key from your account, also accepted as Authorization: Bearer arb_..."},"bearer":{"type":"http","scheme":"bearer","description":"Session token from sign-in (mobile apps)"},"cookie":{"type":"apiKey","in":"cookie","name":"better-auth.session_token"}}},"paths":{"/api/v1/exchanges":{"get":{"operationId":"listExchanges","summary":"List exchanges with market counts and volume","tags":["Exchanges"],"security":[{"apiKey":[]}],"x-credits":1,"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string","enum":["cex","dex"]},"url":{"type":"string","format":"uri"},"perpMarkets":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"spotMarkets":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"volumeUsd":{"type":"number"}},"required":["id","name","kind","url","perpMarkets","spotMarkets","volumeUsd"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/exchanges/{exchange}/funding-rates":{"get":{"operationId":"listExchangeFundingRates","summary":"Every linear perpetual funding rate on one exchange","tags":["Funding"],"security":[{"apiKey":[]}],"x-credits":5,"parameters":[{"name":"exchange","in":"path","required":true,"schema":{"type":"string"}},{"name":"ex","in":"query","required":false,"description":"Comma-separated exchange ids to include","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated exchange ids to include","type":"string"}},{"name":"xex","in":"query","required":false,"description":"Comma-separated exchange ids to exclude","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated exchange ids to exclude","type":"string"}},{"name":"coins","in":"query","required":false,"description":"Comma-separated coins to include","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated coins to include","type":"string"}},{"name":"xcoins","in":"query","required":false,"description":"Comma-separated coins to exclude","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated coins to exclude","type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"exchange":{"type":"string"},"symbol":{"type":"string"},"coin":{"type":"string"},"rate":{"type":"number","description":"Funding rate per interval, as a fraction (0.0001 = 0.01%)"},"intervalHours":{"type":"number"},"apr":{"type":"number","description":"Annualized funding rate, as a fraction"},"markPrice":{"type":"number"},"nextFundingTime":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"tradeUrl":{"type":"string","format":"uri"}},"required":["exchange","symbol","coin","rate","intervalHours","apr"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/funding-rates":{"get":{"operationId":"listFundingRates","summary":"Funding summary for every coin listed on at least two exchanges","tags":["Funding"],"security":[{"apiKey":[]}],"x-credits":5,"parameters":[{"name":"minExchanges","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"integer","minimum":2,"maximum":9007199254740991}},{"name":"minVolumeUsd","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"number","minimum":0}},{"name":"limit","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"integer","minimum":1,"maximum":1000}},{"name":"ex","in":"query","required":false,"description":"Comma-separated exchange ids to include","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated exchange ids to include","type":"string"}},{"name":"xex","in":"query","required":false,"description":"Comma-separated exchange ids to exclude","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated exchange ids to exclude","type":"string"}},{"name":"coins","in":"query","required":false,"description":"Comma-separated coins to include","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated coins to include","type":"string"}},{"name":"xcoins","in":"query","required":false,"description":"Comma-separated coins to exclude","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated coins to exclude","type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string"},"slug":{"type":"string"},"exchanges":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"averageApr":{"type":"number","description":"Average APR weighted by 24h perpetual volume"},"simpleAverageApr":{"type":"number","description":"Unweighted mean APR across exchanges"},"medianApr":{"type":"number"},"spreadApr":{"type":"number","description":"Highest minus lowest APR across markets with at least $100k of 24h volume"},"thin":{"type":"boolean","description":"Fewer than two liquid markets; the spread then uses every market"},"volumeUsd":{"type":"number","description":"24h perpetual volume across the listed markets"},"long":{"type":"object","properties":{"exchange":{"type":"string"},"rate":{"type":"number","description":"Funding rate per interval as a fraction"},"intervalHours":{"type":"number"},"apr":{"type":"number"}},"required":["exchange","rate","intervalHours","apr"],"additionalProperties":false,"description":"Exchange with the lowest funding"},"short":{"type":"object","properties":{"exchange":{"type":"string"},"rate":{"type":"number","description":"Funding rate per interval as a fraction"},"intervalHours":{"type":"number"},"apr":{"type":"number"}},"required":["exchange","rate","intervalHours","apr"],"additionalProperties":false,"description":"Exchange with the highest funding"}},"required":["coin","slug","exchanges","averageApr","simpleAverageApr","medianApr","spreadApr","thin","volumeUsd","long","short"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/funding-rates/{coin}":{"get":{"operationId":"getFundingRates","summary":"Funding rates for one coin on every exchange","tags":["Funding"],"security":[{"apiKey":[]}],"x-credits":1,"parameters":[{"name":"coin","in":"path","required":true,"schema":{"type":"string"}},{"name":"ex","in":"query","required":false,"description":"Comma-separated exchange ids to include","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated exchange ids to include","type":"string"}},{"name":"xex","in":"query","required":false,"description":"Comma-separated exchange ids to exclude","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated exchange ids to exclude","type":"string"}},{"name":"coins","in":"query","required":false,"description":"Comma-separated coins to include","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated coins to include","type":"string"}},{"name":"xcoins","in":"query","required":false,"description":"Comma-separated coins to exclude","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated coins to exclude","type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"coin":{"type":"string"},"slug":{"type":"string"},"exchanges":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"averageApr":{"type":"number","description":"Average APR weighted by 24h perpetual volume"},"simpleAverageApr":{"type":"number","description":"Unweighted mean APR across exchanges"},"medianApr":{"type":"number"},"spreadApr":{"type":"number","description":"Highest minus lowest APR across markets with at least $100k of 24h volume"},"thin":{"type":"boolean","description":"Fewer than two liquid markets; the spread then uses every market"},"volumeUsd":{"type":"number","description":"24h perpetual volume across the listed markets"},"long":{"type":"object","properties":{"exchange":{"type":"string"},"rate":{"type":"number","description":"Funding rate per interval as a fraction"},"intervalHours":{"type":"number"},"apr":{"type":"number"}},"required":["exchange","rate","intervalHours","apr"],"additionalProperties":false,"description":"Exchange with the lowest funding"},"short":{"type":"object","properties":{"exchange":{"type":"string"},"rate":{"type":"number","description":"Funding rate per interval as a fraction"},"intervalHours":{"type":"number"},"apr":{"type":"number"}},"required":["exchange","rate","intervalHours","apr"],"additionalProperties":false,"description":"Exchange with the highest funding"},"rates":{"type":"array","items":{"type":"object","properties":{"exchange":{"type":"string"},"symbol":{"type":"string"},"coin":{"type":"string"},"rate":{"type":"number","description":"Funding rate per interval, as a fraction (0.0001 = 0.01%)"},"intervalHours":{"type":"number"},"apr":{"type":"number","description":"Annualized funding rate, as a fraction"},"markPrice":{"type":"number"},"nextFundingTime":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"tradeUrl":{"type":"string","format":"uri"}},"required":["exchange","symbol","coin","rate","intervalHours","apr"],"additionalProperties":false}}},"required":["coin","slug","exchanges","averageApr","simpleAverageApr","medianApr","spreadApr","thin","volumeUsd","long","short","rates"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/funding-rates/{coin}/history":{"get":{"operationId":"getFundingHistory","summary":"Hourly funding history for one coin. One credit per day asked for; Free up to 7 days, Pro up to 90","tags":["Funding"],"security":[{"apiKey":[]}],"x-credits":1,"parameters":[{"name":"coin","in":"path","required":true,"schema":{"type":"string"}},{"name":"days","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"integer","minimum":1,"maximum":365}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"coin":{"type":"string"},"series":{"type":"array","items":{"type":"object","properties":{"time":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"apr":{"type":"number"}},"required":["time","apr"],"additionalProperties":false},"description":"Hourly average across exchanges"},"exchanges":{"type":"array","items":{"type":"object","properties":{"exchange":{"type":"string"},"currentApr":{"type":"number"},"dayApr":{"type":"number"},"weekApr":{"type":"number"}},"required":["exchange","currentApr"],"additionalProperties":false}}},"required":["coin","series","exchanges"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/arbitrage":{"get":{"operationId":"listArbitrage","summary":"Price arbitrage routes with a positive net spread","tags":["Arbitrage"],"security":[{"apiKey":[]}],"x-credits":5,"parameters":[{"name":"type","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"string","enum":["spot","perp"]}},{"name":"minNetSpread","in":"query","required":false,"description":"Minimum net spread as a fraction (0.001 = 0.1%)","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Minimum net spread as a fraction (0.001 = 0.1%)","type":"number"}},{"name":"limit","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"integer","minimum":1,"maximum":1000}},{"name":"ex","in":"query","required":false,"description":"Comma-separated exchange ids to include","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated exchange ids to include","type":"string"}},{"name":"xex","in":"query","required":false,"description":"Comma-separated exchange ids to exclude","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated exchange ids to exclude","type":"string"}},{"name":"coins","in":"query","required":false,"description":"Comma-separated coins to include","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated coins to include","type":"string"}},{"name":"xcoins","in":"query","required":false,"description":"Comma-separated coins to exclude","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated coins to exclude","type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string"},"slug":{"type":"string"},"type":{"type":"string","enum":["spot","perp"]},"buy":{"type":"object","properties":{"exchange":{"type":"string"},"symbol":{"type":"string"},"price":{"type":"number"},"sizeUsd":{"description":"USD value available at the quoted price","type":"number"},"tradeUrl":{"type":"string","format":"uri"}},"required":["exchange","symbol","price"],"additionalProperties":false},"sell":{"type":"object","properties":{"exchange":{"type":"string"},"symbol":{"type":"string"},"price":{"type":"number"},"sizeUsd":{"description":"USD value available at the quoted price","type":"number"},"tradeUrl":{"type":"string","format":"uri"}},"required":["exchange","symbol","price"],"additionalProperties":false},"grossSpread":{"type":"number"},"fees":{"type":"number"},"netSpread":{"type":"number"},"maxSizeUsd":{"type":"number"},"volumeUsd":{"type":"number"}},"required":["coin","slug","type","buy","sell","grossSpread","fees","netSpread","volumeUsd"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/arbitrage/{coin}":{"get":{"operationId":"getArbitrage","summary":"Best spot and perpetual route for one coin, including unprofitable ones","tags":["Arbitrage"],"security":[{"apiKey":[]}],"x-credits":1,"parameters":[{"name":"coin","in":"path","required":true,"schema":{"type":"string"}},{"name":"ex","in":"query","required":false,"description":"Comma-separated exchange ids to include","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated exchange ids to include","type":"string"}},{"name":"xex","in":"query","required":false,"description":"Comma-separated exchange ids to exclude","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated exchange ids to exclude","type":"string"}},{"name":"coins","in":"query","required":false,"description":"Comma-separated coins to include","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated coins to include","type":"string"}},{"name":"xcoins","in":"query","required":false,"description":"Comma-separated coins to exclude","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated coins to exclude","type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string"},"slug":{"type":"string"},"type":{"type":"string","enum":["spot","perp"]},"buy":{"type":"object","properties":{"exchange":{"type":"string"},"symbol":{"type":"string"},"price":{"type":"number"},"sizeUsd":{"description":"USD value available at the quoted price","type":"number"},"tradeUrl":{"type":"string","format":"uri"}},"required":["exchange","symbol","price"],"additionalProperties":false},"sell":{"type":"object","properties":{"exchange":{"type":"string"},"symbol":{"type":"string"},"price":{"type":"number"},"sizeUsd":{"description":"USD value available at the quoted price","type":"number"},"tradeUrl":{"type":"string","format":"uri"}},"required":["exchange","symbol","price"],"additionalProperties":false},"grossSpread":{"type":"number"},"fees":{"type":"number"},"netSpread":{"type":"number"},"maxSizeUsd":{"type":"number"},"volumeUsd":{"type":"number"}},"required":["coin","slug","type","buy","sell","grossSpread","fees","netSpread","volumeUsd"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/strategies/cash-and-carry":{"get":{"operationId":"listCashAndCarry","summary":"Cash-and-carry trades: buy spot, short the perpetual, earn funding","tags":["Strategies"],"security":[{"apiKey":[]}],"x-credits":5,"parameters":[{"name":"minApr","in":"query","required":false,"description":"Minimum estimated 30-day APR as a fraction","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Minimum estimated 30-day APR as a fraction","type":"number"}},{"name":"sameExchange","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"string","enum":["true","false"]}},{"name":"limit","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"integer","minimum":1,"maximum":1000}},{"name":"ex","in":"query","required":false,"description":"Comma-separated exchange ids to include","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated exchange ids to include","type":"string"}},{"name":"xex","in":"query","required":false,"description":"Comma-separated exchange ids to exclude","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated exchange ids to exclude","type":"string"}},{"name":"coins","in":"query","required":false,"description":"Comma-separated coins to include","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated coins to include","type":"string"}},{"name":"xcoins","in":"query","required":false,"description":"Comma-separated coins to exclude","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated coins to exclude","type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string"},"slug":{"type":"string"},"spot":{"type":"object","properties":{"exchange":{"type":"string"},"symbol":{"type":"string"},"price":{"type":"number"},"sizeUsd":{"description":"USD value available at the quoted price","type":"number"},"tradeUrl":{"type":"string","format":"uri"}},"required":["exchange","symbol","price"],"additionalProperties":false},"perp":{"type":"object","properties":{"exchange":{"type":"string"},"symbol":{"type":"string"},"price":{"type":"number"},"sizeUsd":{"description":"USD value available at the quoted price","type":"number"},"tradeUrl":{"type":"string","format":"uri"}},"required":["exchange","symbol","price"],"additionalProperties":false},"fundingApr":{"type":"number","description":"Funding APR the short perp earns: its 7-day average, or 24h or now while history is short"},"basis":{"type":"number","description":"(perp bid − spot ask) ÷ spot ask"},"fees":{"type":"number","description":"Round-trip taker fees on both legs"},"estimatedApr30d":{"type":"number"},"sameExchange":{"type":"boolean"}},"required":["coin","slug","spot","perp","fundingApr","basis","fees","estimatedApr30d","sameExchange"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/prices/{coin}":{"get":{"operationId":"getPrices","summary":"Live bid and ask for one coin on every exchange and market type","tags":["Prices"],"security":[{"apiKey":[]}],"x-credits":1,"parameters":[{"name":"coin","in":"path","required":true,"schema":{"type":"string"}},{"name":"ex","in":"query","required":false,"description":"Comma-separated exchange ids to include","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated exchange ids to include","type":"string"}},{"name":"xex","in":"query","required":false,"description":"Comma-separated exchange ids to exclude","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated exchange ids to exclude","type":"string"}},{"name":"coins","in":"query","required":false,"description":"Comma-separated coins to include","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated coins to include","type":"string"}},{"name":"xcoins","in":"query","required":false,"description":"Comma-separated coins to exclude","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Comma-separated coins to exclude","type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"exchange":{"type":"string"},"symbol":{"type":"string"},"type":{"type":"string","enum":["spot","perp"]},"bid":{"type":"number"},"ask":{"type":"number"},"volumeUsd":{"type":"number"},"takerFee":{"type":"number"},"tradeUrl":{"type":"string","format":"uri"}},"required":["exchange","symbol","type","bid","ask","takerFee"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/pulse":{"get":{"operationId":"getMarketPulse","summary":"Headline market figures shown in the site header","tags":["Site"],"security":[{}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"prices":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string"},"price":{"type":"number","description":"Median mid price of liquid perpetual markets"},"fundingApr":{"description":"Volume-weighted average funding APR","type":["number","null"]}},"required":["coin","price","fundingApr"],"additionalProperties":false}},"arbitrage":{"type":"object","properties":{"routes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Price arbitrage routes with a positive net spread"},"best":{"anyOf":[{"type":"object","properties":{"coin":{"type":"string"},"slug":{"type":"string"},"type":{"type":"string","enum":["spot","perp"]},"netSpread":{"type":"number"}},"required":["coin","slug","type","netSpread"],"additionalProperties":false},{"type":"null"}],"description":"Widest net spread with at least $1M of 24h volume on both legs"}},"required":["routes","best"],"additionalProperties":false},"funding":{"type":"object","properties":{"routes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Coins whose funding-rate gap between two exchanges nets a profit on the default plan ($100, one week)"}},"required":["routes"],"additionalProperties":false},"exchanges":{"type":"object","properties":{"live":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["live","total"],"additionalProperties":false},"feeds":{"type":"object","properties":{"funding":{"type":"object","properties":{"live":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"collected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["live","collected"],"additionalProperties":false},"tickers":{"type":"object","properties":{"live":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"collected":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["live","collected"],"additionalProperties":false}},"required":["funding","tickers"],"additionalProperties":false,"description":"Feeds updating on time, out of the feeds ArbTide collects"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Latest price or funding update; null when no data is available"}},"required":["prices","arbitrage","funding","exchanges","feeds","updatedAt"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/status":{"get":{"operationId":"getStatus","summary":"Data collection status of every exchange and stream","tags":["Status"],"security":[{"apiKey":[]}],"x-credits":1,"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"checkedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"operational":{"type":"number"},"degraded":{"type":"number"},"down":{"type":"number"},"exchanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"funding":{"type":"object","properties":{"state":{"type":"string","enum":["operational","degraded","down","not_collected"]},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"latencyMs":{"type":"number"},"items":{"type":"number"},"error":{"type":"string"}},"required":["state"],"additionalProperties":false},"tickers":{"type":"object","properties":{"state":{"type":"string","enum":["operational","degraded","down","not_collected"]},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"latencyMs":{"type":"number"},"items":{"type":"number"},"error":{"type":"string"}},"required":["state"],"additionalProperties":false}},"required":["id","name","funding","tickers"],"additionalProperties":false}}},"required":["checkedAt","operational","degraded","down","exchanges"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me":{"get":{"operationId":"getMe","summary":"Current user","tags":["Account"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"plan":{"type":"string","enum":["free","pro","ultra"]},"planExpiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When a paid plan ends; null for free or indefinite plans"},"limits":{"type":"object","properties":{"watchlist":{"type":"number"},"apiCredits":{"type":"number","description":"API credits per quota period: a UTC day on Free, a UTC month on paid plans"},"apiCreditsPerSecond":{"type":"number","description":"Credits the rate limit refills per second"},"apiKeys":{"type":"number"},"historyDays":{"type":"number"},"alerts":{"type":"number"}},"required":["watchlist","apiCredits","apiCreditsPerSecond","apiKeys","historyDays","alerts"],"additionalProperties":false}},"required":["id","name","email","plan","planExpiresAt","limits"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/setup":{"get":{"operationId":"getSetup","summary":"Setup checklist progress and founding-member status","tags":["Account"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"tasks":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","enum":["watch","alert","channel"]},"done":{"type":"boolean"},"have":{"type":"number"},"need":{"type":"number"}},"required":["key","done","have","need"],"additionalProperties":false}},"complete":{"type":"boolean"},"foundingMemberAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When setup was first completed; null until then"},"justCompleted":{"type":"boolean","description":"True only on the request that awarded founding-member status"},"trialStarted":{"type":"boolean","description":"True only on the request that started the one-time Pro trial"},"trialEndsAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the one-time Pro trial ends or ended; null if there was none"}},"required":["tasks","complete","foundingMemberAt","justCompleted","trialStarted","trialEndsAt"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/billing":{"get":{"operationId":"getBillingOptions","summary":"Plans, prepaid periods, prices and available payment methods","tags":["Billing"],"security":[{}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"methods":{"type":"object","properties":{"crypto":{"type":"boolean"},"card":{"type":"boolean"}},"required":["crypto","card"],"additionalProperties":false},"launchOfferEndsAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When the launch prices on longer periods end; null once they have"},"plans":{"type":"array","items":{"type":"object","properties":{"plan":{"type":"string","enum":["pro","ultra"]},"monthlyUsd":{"type":"number"},"periods":{"type":"array","items":{"type":"object","properties":{"months":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"discount":{"type":"number","description":"Share saved against paying the monthly price for every month, at the price now"},"priceUsd":{"type":"number","description":"The price now, including any launch price"},"regularUsd":{"type":"number","description":"The regular price after the launch offer"}},"required":["months","discount","priceUsd","regularUsd"],"additionalProperties":false}},"cardMonths":{"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"description":"Card renewal periods on offer, in months"}},"required":["plan","monthlyUsd","periods","cardMonths"],"additionalProperties":false}}},"required":["methods","launchOfferEndsAt","plans"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/checkout":{"post":{"operationId":"createCheckout","summary":"Start a checkout for a paid plan. Crypto buys prepaid months; card starts a monthly subscription","tags":["Billing"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"plan":{"type":"string","enum":["pro","ultra"]},"months":{"anyOf":[{"type":"number","const":1},{"type":"number","const":3},{"type":"number","const":12}],"description":"Prepaid months; card payments renew every 1 or 12 months"},"method":{"type":"string","enum":["crypto","card"]}},"required":["plan","months","method"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Hosted checkout page to open"}},"required":["url"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/waitlist":{"post":{"operationId":"joinWaitlist","summary":"Ask to be told when a plan that is coming soon opens","tags":["Billing"],"security":[{}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"plan":{"type":"string","enum":["pro","ultra"],"description":"Plan to hear about when it opens"},"email":{"description":"Required when not signed in; a signed-in account uses its own address","type":"string","maxLength":254,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"}},"required":["plan"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"joined":{"type":"boolean","description":"False when the address was already on the list"}},"required":["joined"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/payments":{"get":{"operationId":"listPayments","summary":"Payment history of the current user","tags":["Billing"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"provider":{"type":"string","enum":["nowpayments","paddle"]},"plan":{"type":"string","enum":["pro","ultra"]},"months":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"amountUsd":{"type":"number"},"status":{"type":"string","enum":["pending","confirming","partial","review","paid","failed","expired","refunded"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"paidAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}]}},"required":["id","provider","plan","months","amountUsd","status","createdAt","paidAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/email-preferences":{"get":{"operationId":"getEmailPreferences","summary":"Which emails you receive","tags":["Account"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"digest":{"type":"string","enum":["off","daily","weekly"],"description":"How often to send the digest of your alerts and coins"},"tips":{"type":"boolean","description":"Setup tips and trial emails"}},"required":["digest","tips"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"updateEmailPreferences","summary":"Change which emails you receive","tags":["Account"],"security":[{"cookie":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"digest":{"type":"string","enum":["off","daily","weekly"],"description":"How often to send the digest of your alerts and coins"},"tips":{"type":"boolean","description":"Setup tips and trial emails"}},"required":["digest","tips"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"digest":{"type":"string","enum":["off","daily","weekly"],"description":"How often to send the digest of your alerts and coins"},"tips":{"type":"boolean","description":"Setup tips and trial emails"}},"required":["digest","tips"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/fees":{"get":{"operationId":"getFeeOverrides","summary":"Your own taker fees per exchange, used in every net figure you see","tags":["Account"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"exchange":{"type":"string"},"spotTaker":{"anyOf":[{"type":"number","minimum":0,"maximum":0.01},{"type":"null"}],"description":"Taker fee as a fraction, e.g. 0.0006 for 0.06%"},"perpTaker":{"anyOf":[{"type":"number","minimum":0,"maximum":0.01},{"type":"null"}],"description":"Taker fee as a fraction, e.g. 0.0006 for 0.06%"}},"required":["exchange","spotTaker","perpTaker"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"updateFeeOverrides","summary":"Replace your taker fees per exchange","tags":["Account"],"security":[{"cookie":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"overrides":{"maxItems":60,"type":"array","items":{"type":"object","properties":{"exchange":{"type":"string"},"spotTaker":{"anyOf":[{"type":"number","minimum":0,"maximum":0.01},{"type":"null"}],"description":"Taker fee as a fraction, e.g. 0.0006 for 0.06%"},"perpTaker":{"anyOf":[{"type":"number","minimum":0,"maximum":0.01},{"type":"null"}],"description":"Taker fee as a fraction, e.g. 0.0006 for 0.06%"}},"required":["exchange","spotTaker","perpTaker"],"additionalProperties":false}}},"required":["overrides"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"exchange":{"type":"string"},"spotTaker":{"anyOf":[{"type":"number","minimum":0,"maximum":0.01},{"type":"null"}],"description":"Taker fee as a fraction, e.g. 0.0006 for 0.06%"},"perpTaker":{"anyOf":[{"type":"number","minimum":0,"maximum":0.01},{"type":"null"}],"description":"Taker fee as a fraction, e.g. 0.0006 for 0.06%"}},"required":["exchange","spotTaker","perpTaker"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/watchlist":{"get":{"operationId":"getWatchlist","summary":"Coins on the current user watchlist","tags":["Account"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"coins":{"type":"array","items":{"type":"string"}}},"required":["coins"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"addToWatchlist","summary":"Add a coin to the watchlist","tags":["Account"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"coin":{"type":"string","pattern":"^[A-Za-z0-9]{1,24}$"}},"required":["coin"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"coins":{"type":"array","items":{"type":"string"}}},"required":["coins"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/watchlist-notifications":{"get":{"operationId":"getWatchlistNotices","summary":"Your watchlist notifications: the daily digest and funding flips on watchlist coins","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"digest":{"type":"boolean","description":"Send the daily digest: your top three watchlist coins with their best funding and open net spread, once a day at digestHour. Skipped on days with an empty watchlist or nothing meaningful. On by default"},"digestHour":{"type":"integer","minimum":0,"maximum":23,"description":"Local hour of day (0 to 23) the digest is sent, in timeZone. Defaults to 9"},"flips":{"type":"boolean","description":"Send a notice when the market funding of a watchlist coin (the median across exchanges, with a small dead-band around zero) changes sign: at most one per coin per 12 hours and three per day (UTC) in all. On by default"},"push":{"type":"boolean","description":"Send these notifications to your browser push channels. On by default"},"telegram":{"type":"boolean","description":"Send these notifications to your Telegram channels. Off by default"},"timeZone":{"anyOf":[{"type":"string","maxLength":64,"description":"IANA time zone, for example Europe/Istanbul. The website sets it from your browser"},{"type":"null"}],"description":"IANA time zone of the digest hour; null until the website has sent it"},"ready":{"type":"boolean","description":"True when something can be sent: the time zone is known and at least one chosen channel type has a connected channel. Notifications here do not count toward channel limits or the plan daily message cap, and are not written to the alert log"}},"required":["digest","digestHour","flips","push","telegram","timeZone","ready"],"additionalProperties":false,"description":"Watchlist notifications; every member has them, with the defaults, until they change something"},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"updateWatchlistNotices","summary":"Change your watchlist notifications: on or off, digest hour, time zone and channel types","tags":["Alerts"],"security":[{"cookie":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"digest":{"type":"boolean","description":"Send the daily digest: your top three watchlist coins with their best funding and open net spread, once a day at digestHour. Skipped on days with an empty watchlist or nothing meaningful. On by default"},"digestHour":{"type":"integer","minimum":0,"maximum":23,"description":"Local hour of day (0 to 23) the digest is sent, in timeZone. Defaults to 9"},"flips":{"type":"boolean","description":"Send a notice when the market funding of a watchlist coin (the median across exchanges, with a small dead-band around zero) changes sign: at most one per coin per 12 hours and three per day (UTC) in all. On by default"},"push":{"type":"boolean","description":"Send these notifications to your browser push channels. On by default"},"telegram":{"type":"boolean","description":"Send these notifications to your Telegram channels. Off by default"},"timeZone":{"type":"string","maxLength":64,"description":"IANA time zone, for example Europe/Istanbul. The website sets it from your browser"}},"additionalProperties":false,"description":"Only the fields you send change"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"digest":{"type":"boolean","description":"Send the daily digest: your top three watchlist coins with their best funding and open net spread, once a day at digestHour. Skipped on days with an empty watchlist or nothing meaningful. On by default"},"digestHour":{"type":"integer","minimum":0,"maximum":23,"description":"Local hour of day (0 to 23) the digest is sent, in timeZone. Defaults to 9"},"flips":{"type":"boolean","description":"Send a notice when the market funding of a watchlist coin (the median across exchanges, with a small dead-band around zero) changes sign: at most one per coin per 12 hours and three per day (UTC) in all. On by default"},"push":{"type":"boolean","description":"Send these notifications to your browser push channels. On by default"},"telegram":{"type":"boolean","description":"Send these notifications to your Telegram channels. Off by default"},"timeZone":{"anyOf":[{"type":"string","maxLength":64,"description":"IANA time zone, for example Europe/Istanbul. The website sets it from your browser"},{"type":"null"}],"description":"IANA time zone of the digest hour; null until the website has sent it"},"ready":{"type":"boolean","description":"True when something can be sent: the time zone is known and at least one chosen channel type has a connected channel. Notifications here do not count toward channel limits or the plan daily message cap, and are not written to the alert log"}},"required":["digest","digestHour","flips","push","telegram","timeZone","ready"],"additionalProperties":false,"description":"Watchlist notifications; every member has them, with the defaults, until they change something"},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/watchlist/{coin}":{"delete":{"operationId":"removeFromWatchlist","summary":"Remove a coin from the watchlist","tags":["Account"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[{"name":"coin","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"coins":{"type":"array","items":{"type":"string"}}},"required":["coins"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/api-keys":{"get":{"operationId":"listApiKeys","summary":"API keys of the current user","tags":["API keys"],"security":[{"cookie":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefix":{"type":"string"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"lastUsedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Null for a key that never expires"},"scopes":{"type":"array","items":{"type":"string","enum":["market","account"]},"description":"market: public data; account: the watchlist, alerts and channels"},"allowedIps":{"type":"array","items":{"type":"string"},"description":"Empty allows every address"},"status":{"type":"string","enum":["active","expiring","retiring","expired"],"description":"expiring: ends within 7 days; retiring: replaced by a rotated key and ends within 24 hours"},"creditsThisMonth":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits this key spent this UTC month"}},"required":["id","name","prefix","createdAt","expiresAt","scopes","allowedIps","status","creditsThisMonth"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createApiKey","summary":"Create an API key. The key is returned once.","tags":["API keys"],"security":[{"cookie":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":50},"expiresInDays":{"default":30,"description":"30, 90 or 365 days, or null for no expiry (Pro)","anyOf":[{"type":"number","const":30},{"type":"number","const":90},{"type":"number","const":365},{"type":"null"}]},"scopes":{"default":["market"],"minItems":1,"type":"array","items":{"type":"string","enum":["market","account"]}},"allowedIps":{"default":[],"description":"Pro: limit the key to these addresses","maxItems":20,"type":"array","items":{"type":"string"}}},"required":["name","expiresInDays","scopes","allowedIps"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefix":{"type":"string"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"lastUsedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Null for a key that never expires"},"scopes":{"type":"array","items":{"type":"string","enum":["market","account"]},"description":"market: public data; account: the watchlist, alerts and channels"},"allowedIps":{"type":"array","items":{"type":"string"},"description":"Empty allows every address"},"status":{"type":"string","enum":["active","expiring","retiring","expired"],"description":"expiring: ends within 7 days; retiring: replaced by a rotated key and ends within 24 hours"},"creditsThisMonth":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits this key spent this UTC month"},"key":{"type":"string","description":"Shown once. Store it securely."}},"required":["id","name","prefix","createdAt","expiresAt","scopes","allowedIps","status","creditsThisMonth","key"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/api-keys/{id}":{"patch":{"operationId":"updateApiKey","summary":"Rename an API key or change its allowed IP addresses","tags":["API keys"],"security":[{"cookie":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":50},"allowedIps":{"maxItems":20,"type":"array","items":{"type":"string"}}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefix":{"type":"string"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"lastUsedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Null for a key that never expires"},"scopes":{"type":"array","items":{"type":"string","enum":["market","account"]},"description":"market: public data; account: the watchlist, alerts and channels"},"allowedIps":{"type":"array","items":{"type":"string"},"description":"Empty allows every address"},"status":{"type":"string","enum":["active","expiring","retiring","expired"],"description":"expiring: ends within 7 days; retiring: replaced by a rotated key and ends within 24 hours"},"creditsThisMonth":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits this key spent this UTC month"}},"required":["id","name","prefix","createdAt","expiresAt","scopes","allowedIps","status","creditsThisMonth"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"delete":{"operationId":"revokeApiKey","summary":"Revoke an API key at once","tags":["API keys"],"security":[{"cookie":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefix":{"type":"string"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"lastUsedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Null for a key that never expires"},"scopes":{"type":"array","items":{"type":"string","enum":["market","account"]},"description":"market: public data; account: the watchlist, alerts and channels"},"allowedIps":{"type":"array","items":{"type":"string"},"description":"Empty allows every address"},"status":{"type":"string","enum":["active","expiring","retiring","expired"],"description":"expiring: ends within 7 days; retiring: replaced by a rotated key and ends within 24 hours"},"creditsThisMonth":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits this key spent this UTC month"}},"required":["id","name","prefix","createdAt","expiresAt","scopes","allowedIps","status","creditsThisMonth"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/api-keys/{id}/rotate":{"post":{"operationId":"rotateApiKey","summary":"Replace an API key with a new one; the old key keeps working for 24 hours","tags":["API keys"],"security":[{"cookie":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"prefix":{"type":"string"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"lastUsedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"expiresAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"Null for a key that never expires"},"scopes":{"type":"array","items":{"type":"string","enum":["market","account"]},"description":"market: public data; account: the watchlist, alerts and channels"},"allowedIps":{"type":"array","items":{"type":"string"},"description":"Empty allows every address"},"status":{"type":"string","enum":["active","expiring","retiring","expired"],"description":"expiring: ends within 7 days; retiring: replaced by a rotated key and ends within 24 hours"},"creditsThisMonth":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Credits this key spent this UTC month"},"key":{"type":"string","description":"Shown once. Store it securely."}},"required":["id","name","prefix","createdAt","expiresAt","scopes","allowedIps","status","creditsThisMonth","key"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/api-usage":{"get":{"operationId":"getApiUsage","summary":"Credits used this period, the quota and rate limit, and usage per day and endpoint","tags":["API keys"],"security":[{"cookie":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"plan":{"type":"string","enum":["free","pro","ultra"]},"period":{"type":"object","properties":{"id":{"type":"string"},"resetsAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","resetsAt"],"additionalProperties":false},"quota":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"used":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"remaining":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"creditsPerSecond":{"type":"number"},"burstCredits":{"type":"number"},"historyDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"keys":{"type":"object","properties":{"used":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["used","limit"],"additionalProperties":false},"days":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"credits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"requests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["day","credits","requests"],"additionalProperties":false}},"endpoints":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"credits":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"requests":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["name","credits","requests"],"additionalProperties":false}}},"required":["plan","period","quota","used","remaining","creditsPerSecond","burstCredits","historyDays","keys","days","endpoints"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/channels":{"get":{"operationId":"listChannels","summary":"Notification channels (Telegram chats and webhooks)","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","enum":["telegram","webhook","email","browser"]},"label":{"type":"string"},"target":{"type":"string"},"webhook":{"type":"object","properties":{"format":{"default":"arbtide","description":"arbtide (signed JSON), discord, slack or custom","type":"string","enum":["arbtide","discord","slack","custom"]},"method":{"default":"POST","description":"HTTP method, used by the custom format","type":"string","enum":["POST","PUT","PATCH"]},"contentType":{"default":"application/json","description":"Used by the custom format","type":"string","enum":["application/json","text/plain","application/x-www-form-urlencoded"]},"headers":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"value":{"type":"string","maxLength":1000}},"required":["name","value"],"additionalProperties":false}},"body":{"default":"","description":"Custom body template with {{variable}} placeholders","type":"string","maxLength":8000}},"required":["format","method","contentType","headers","body"],"additionalProperties":false},"lastDelivery":{"description":"Most recent delivery attempt, including tests","type":"object","properties":{"status":{"type":"string","enum":["sent","failed","skipped","held","paced","bundled"],"description":"sent, failed or skipped are final. held waits for the channel limit and paced for the alert minimum gap; both end as bundled once a bundled message or summary carried them"},"error":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["status","error","createdAt"],"additionalProperties":false},"hourlyLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":60},{"type":"null"}],"description":"Most messages this channel is sent per UTC clock hour; null is no limit of its own. Over it, alerts are held and sent together in one summary, never dropped. New browser push channels start at 4, Telegram at 10"},"dailyLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}],"description":"Most messages this channel is sent per UTC day, the same day as the plan cap; null is no limit of its own. New browser push channels start at 24. The plan cap still applies on top"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","kind","label","target","hourlyLimit","dailyLimit","createdAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/channels/webhook":{"post":{"operationId":"createWebhookChannel","summary":"Add an HTTPS webhook: signed ArbTide JSON, Discord, Slack or a custom body template","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":50},"url":{"type":"string","format":"uri"},"config":{"type":"object","properties":{"format":{"default":"arbtide","description":"arbtide (signed JSON), discord, slack or custom","type":"string","enum":["arbtide","discord","slack","custom"]},"method":{"default":"POST","description":"HTTP method, used by the custom format","type":"string","enum":["POST","PUT","PATCH"]},"contentType":{"default":"application/json","description":"Used by the custom format","type":"string","enum":["application/json","text/plain","application/x-www-form-urlencoded"]},"headers":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"value":{"type":"string","maxLength":1000}},"required":["name","value"],"additionalProperties":false}},"body":{"default":"","description":"Custom body template with {{variable}} placeholders","type":"string","maxLength":8000}},"required":["format","method","contentType","headers","body"],"additionalProperties":false}},"required":["label","url"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","enum":["telegram","webhook","email","browser"]},"label":{"type":"string"},"target":{"type":"string"},"webhook":{"type":"object","properties":{"format":{"default":"arbtide","description":"arbtide (signed JSON), discord, slack or custom","type":"string","enum":["arbtide","discord","slack","custom"]},"method":{"default":"POST","description":"HTTP method, used by the custom format","type":"string","enum":["POST","PUT","PATCH"]},"contentType":{"default":"application/json","description":"Used by the custom format","type":"string","enum":["application/json","text/plain","application/x-www-form-urlencoded"]},"headers":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"value":{"type":"string","maxLength":1000}},"required":["name","value"],"additionalProperties":false}},"body":{"default":"","description":"Custom body template with {{variable}} placeholders","type":"string","maxLength":8000}},"required":["format","method","contentType","headers","body"],"additionalProperties":false},"lastDelivery":{"description":"Most recent delivery attempt, including tests","type":"object","properties":{"status":{"type":"string","enum":["sent","failed","skipped","held","paced","bundled"],"description":"sent, failed or skipped are final. held waits for the channel limit and paced for the alert minimum gap; both end as bundled once a bundled message or summary carried them"},"error":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["status","error","createdAt"],"additionalProperties":false},"hourlyLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":60},{"type":"null"}],"description":"Most messages this channel is sent per UTC clock hour; null is no limit of its own. Over it, alerts are held and sent together in one summary, never dropped. New browser push channels start at 4, Telegram at 10"},"dailyLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}],"description":"Most messages this channel is sent per UTC day, the same day as the plan cap; null is no limit of its own. New browser push channels start at 24. The plan cap still applies on top"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"secret":{"type":"string","description":"Signing secret, shown once"}},"required":["id","kind","label","target","hourlyLimit","dailyLimit","createdAt","secret"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/channels/email":{"post":{"operationId":"createEmailChannel","summary":"Send alerts to your verified account email","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","enum":["telegram","webhook","email","browser"]},"label":{"type":"string"},"target":{"type":"string"},"webhook":{"type":"object","properties":{"format":{"default":"arbtide","description":"arbtide (signed JSON), discord, slack or custom","type":"string","enum":["arbtide","discord","slack","custom"]},"method":{"default":"POST","description":"HTTP method, used by the custom format","type":"string","enum":["POST","PUT","PATCH"]},"contentType":{"default":"application/json","description":"Used by the custom format","type":"string","enum":["application/json","text/plain","application/x-www-form-urlencoded"]},"headers":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"value":{"type":"string","maxLength":1000}},"required":["name","value"],"additionalProperties":false}},"body":{"default":"","description":"Custom body template with {{variable}} placeholders","type":"string","maxLength":8000}},"required":["format","method","contentType","headers","body"],"additionalProperties":false},"lastDelivery":{"description":"Most recent delivery attempt, including tests","type":"object","properties":{"status":{"type":"string","enum":["sent","failed","skipped","held","paced","bundled"],"description":"sent, failed or skipped are final. held waits for the channel limit and paced for the alert minimum gap; both end as bundled once a bundled message or summary carried them"},"error":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["status","error","createdAt"],"additionalProperties":false},"hourlyLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":60},{"type":"null"}],"description":"Most messages this channel is sent per UTC clock hour; null is no limit of its own. Over it, alerts are held and sent together in one summary, never dropped. New browser push channels start at 4, Telegram at 10"},"dailyLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}],"description":"Most messages this channel is sent per UTC day, the same day as the plan cap; null is no limit of its own. New browser push channels start at 24. The plan cap still applies on top"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","kind","label","target","hourlyLimit","dailyLimit","createdAt"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/channels/browser":{"post":{"operationId":"createBrowserChannel","summary":"Send alerts as push notifications to a browser or installed app","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":50},"endpoint":{"type":"string","maxLength":2000,"format":"uri","description":"PushSubscription.endpoint from the browser"},"keys":{"type":"object","properties":{"p256dh":{"type":"string","minLength":1,"maxLength":200},"auth":{"type":"string","minLength":1,"maxLength":100}},"required":["p256dh","auth"],"additionalProperties":false}},"required":["label","endpoint","keys"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","enum":["telegram","webhook","email","browser"]},"label":{"type":"string"},"target":{"type":"string"},"webhook":{"type":"object","properties":{"format":{"default":"arbtide","description":"arbtide (signed JSON), discord, slack or custom","type":"string","enum":["arbtide","discord","slack","custom"]},"method":{"default":"POST","description":"HTTP method, used by the custom format","type":"string","enum":["POST","PUT","PATCH"]},"contentType":{"default":"application/json","description":"Used by the custom format","type":"string","enum":["application/json","text/plain","application/x-www-form-urlencoded"]},"headers":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"value":{"type":"string","maxLength":1000}},"required":["name","value"],"additionalProperties":false}},"body":{"default":"","description":"Custom body template with {{variable}} placeholders","type":"string","maxLength":8000}},"required":["format","method","contentType","headers","body"],"additionalProperties":false},"lastDelivery":{"description":"Most recent delivery attempt, including tests","type":"object","properties":{"status":{"type":"string","enum":["sent","failed","skipped","held","paced","bundled"],"description":"sent, failed or skipped are final. held waits for the channel limit and paced for the alert minimum gap; both end as bundled once a bundled message or summary carried them"},"error":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["status","error","createdAt"],"additionalProperties":false},"hourlyLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":60},{"type":"null"}],"description":"Most messages this channel is sent per UTC clock hour; null is no limit of its own. Over it, alerts are held and sent together in one summary, never dropped. New browser push channels start at 4, Telegram at 10"},"dailyLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}],"description":"Most messages this channel is sent per UTC day, the same day as the plan cap; null is no limit of its own. New browser push channels start at 24. The plan cap still applies on top"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","kind","label","target","hourlyLimit","dailyLimit","createdAt"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/channels/telegram":{"post":{"operationId":"createTelegramLink","summary":"Create a one-time link that connects a Telegram chat","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["url","expiresAt"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/channels/{id}/test":{"post":{"operationId":"testChannel","summary":"Send a test notification","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"queued":{"type":"boolean"}},"required":["queued"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/channels/{id}":{"patch":{"operationId":"updateChannel","summary":"Rename a channel, set its hourly and daily message limits, or change a webhook URL, format, headers or body","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":50},"url":{"description":"Webhooks only","type":"string","format":"uri"},"config":{"description":"Webhooks only","type":"object","properties":{"format":{"default":"arbtide","description":"arbtide (signed JSON), discord, slack or custom","type":"string","enum":["arbtide","discord","slack","custom"]},"method":{"default":"POST","description":"HTTP method, used by the custom format","type":"string","enum":["POST","PUT","PATCH"]},"contentType":{"default":"application/json","description":"Used by the custom format","type":"string","enum":["application/json","text/plain","application/x-www-form-urlencoded"]},"headers":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"value":{"type":"string","maxLength":1000}},"required":["name","value"],"additionalProperties":false}},"body":{"default":"","description":"Custom body template with {{variable}} placeholders","type":"string","maxLength":8000}},"required":["format","method","contentType","headers","body"],"additionalProperties":false},"hourlyLimit":{"description":"Most messages per UTC hour, 1 to 60, or null for no limit of its own","anyOf":[{"type":"integer","minimum":1,"maximum":60},{"type":"null"}]},"dailyLimit":{"description":"Most messages per UTC day, 1 to 1000, or null for no limit of its own","anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}]}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","enum":["telegram","webhook","email","browser"]},"label":{"type":"string"},"target":{"type":"string"},"webhook":{"type":"object","properties":{"format":{"default":"arbtide","description":"arbtide (signed JSON), discord, slack or custom","type":"string","enum":["arbtide","discord","slack","custom"]},"method":{"default":"POST","description":"HTTP method, used by the custom format","type":"string","enum":["POST","PUT","PATCH"]},"contentType":{"default":"application/json","description":"Used by the custom format","type":"string","enum":["application/json","text/plain","application/x-www-form-urlencoded"]},"headers":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"value":{"type":"string","maxLength":1000}},"required":["name","value"],"additionalProperties":false}},"body":{"default":"","description":"Custom body template with {{variable}} placeholders","type":"string","maxLength":8000}},"required":["format","method","contentType","headers","body"],"additionalProperties":false},"lastDelivery":{"description":"Most recent delivery attempt, including tests","type":"object","properties":{"status":{"type":"string","enum":["sent","failed","skipped","held","paced","bundled"],"description":"sent, failed or skipped are final. held waits for the channel limit and paced for the alert minimum gap; both end as bundled once a bundled message or summary carried them"},"error":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["status","error","createdAt"],"additionalProperties":false},"hourlyLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":60},{"type":"null"}],"description":"Most messages this channel is sent per UTC clock hour; null is no limit of its own. Over it, alerts are held and sent together in one summary, never dropped. New browser push channels start at 4, Telegram at 10"},"dailyLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}],"description":"Most messages this channel is sent per UTC day, the same day as the plan cap; null is no limit of its own. New browser push channels start at 24. The plan cap still applies on top"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","kind","label","target","hourlyLimit","dailyLimit","createdAt"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteChannel","summary":"Remove a notification channel and its alerts","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","enum":["telegram","webhook","email","browser"]},"label":{"type":"string"},"target":{"type":"string"},"webhook":{"type":"object","properties":{"format":{"default":"arbtide","description":"arbtide (signed JSON), discord, slack or custom","type":"string","enum":["arbtide","discord","slack","custom"]},"method":{"default":"POST","description":"HTTP method, used by the custom format","type":"string","enum":["POST","PUT","PATCH"]},"contentType":{"default":"application/json","description":"Used by the custom format","type":"string","enum":["application/json","text/plain","application/x-www-form-urlencoded"]},"headers":{"default":[],"maxItems":10,"type":"array","items":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":64},"value":{"type":"string","maxLength":1000}},"required":["name","value"],"additionalProperties":false}},"body":{"default":"","description":"Custom body template with {{variable}} placeholders","type":"string","maxLength":8000}},"required":["format","method","contentType","headers","body"],"additionalProperties":false},"lastDelivery":{"description":"Most recent delivery attempt, including tests","type":"object","properties":{"status":{"type":"string","enum":["sent","failed","skipped","held","paced","bundled"],"description":"sent, failed or skipped are final. held waits for the channel limit and paced for the alert minimum gap; both end as bundled once a bundled message or summary carried them"},"error":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["status","error","createdAt"],"additionalProperties":false},"hourlyLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":60},{"type":"null"}],"description":"Most messages this channel is sent per UTC clock hour; null is no limit of its own. Over it, alerts are held and sent together in one summary, never dropped. New browser push channels start at 4, Telegram at 10"},"dailyLimit":{"anyOf":[{"type":"integer","minimum":1,"maximum":1000},{"type":"null"}],"description":"Most messages this channel is sent per UTC day, the same day as the plan cap; null is no limit of its own. New browser push channels start at 24. The plan cap still applies on top"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","kind","label","target","hourlyLimit","dailyLimit","createdAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/channels/{id}/alerts":{"post":{"operationId":"attachChannelToAlerts","summary":"Also deliver the chosen alerts to this channel; alerts already using it are left as they are","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"alertIds":{"minItems":1,"maxItems":50,"type":"array","items":{"type":"string"},"description":"Alerts that should also be delivered to this channel"}},"required":["alertIds"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string"},"conditions":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"price-arbitrage"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"market":{"type":"string","enum":["spot","perp","any"]},"minNetSpread":{"type":"number","minimum":-1,"maximum":1,"description":"Minimum net spread after taker fees, as a fraction"},"minSizeUsd":{"description":"Minimum top-of-book size in USD","type":"number","minimum":0},"minDepthUsd":{"description":"Pro: minimum order-book depth in USD that still nets a profit; only routes with a fresh depth scan can match","type":"number","minimum":0},"skipBlocked":{"description":"Leave out spot routes whose withdrawal, deposit or network is closed","type":"boolean"}},"required":["kind","scope","market","minNetSpread"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-spread"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minSpreadApr":{"type":"number","minimum":0,"maximum":100,"description":"Minimum APR spread between the chosen exchanges, as a fraction"},"includeThin":{"type":"boolean"}},"required":["kind","scope","minSpreadApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-rate"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["above","below"]},"apr":{"type":"number","minimum":-100,"maximum":100,"description":"APR threshold on a single exchange, as a fraction"}},"required":["kind","scope","direction","apr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-flip"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["negative","positive","either"]},"minApr":{"type":"number","minimum":0,"maximum":1,"description":"Rates closer to zero than this APR do not count as a flip"}},"required":["kind","scope","direction","minApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cash-and-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"reverse-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"perp-premium"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["premium","discount","either"]},"minPremium":{"type":"number","minimum":0,"maximum":1,"description":"Minimum perp premium or discount to spot, as a fraction"}},"required":["kind","scope","direction","minPremium"],"additionalProperties":false}]},"channelIds":{"type":"array","items":{"type":"string"}},"cooldownMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"minGapMinutes":{"anyOf":[{"type":"integer","minimum":5,"maximum":1440},{"type":"null"}],"description":"Most one message every this many minutes for this alert, whichever opportunities trigger it; null is off. Matches in between are still logged in the app, held, and sent together in one bundled message once the gap has passed. Not the cooldown, which is per opportunity. New alerts default to 30"},"active":{"type":"boolean"},"triggerCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastTriggeredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","name","kind","conditions","channelIds","cooldownMinutes","minGapMinutes","active","triggerCount","lastTriggeredAt","createdAt","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/alerts":{"get":{"operationId":"listAlerts","summary":"Alert rules","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string"},"conditions":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"price-arbitrage"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"market":{"type":"string","enum":["spot","perp","any"]},"minNetSpread":{"type":"number","minimum":-1,"maximum":1,"description":"Minimum net spread after taker fees, as a fraction"},"minSizeUsd":{"description":"Minimum top-of-book size in USD","type":"number","minimum":0},"minDepthUsd":{"description":"Pro: minimum order-book depth in USD that still nets a profit; only routes with a fresh depth scan can match","type":"number","minimum":0},"skipBlocked":{"description":"Leave out spot routes whose withdrawal, deposit or network is closed","type":"boolean"}},"required":["kind","scope","market","minNetSpread"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-spread"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minSpreadApr":{"type":"number","minimum":0,"maximum":100,"description":"Minimum APR spread between the chosen exchanges, as a fraction"},"includeThin":{"type":"boolean"}},"required":["kind","scope","minSpreadApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-rate"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["above","below"]},"apr":{"type":"number","minimum":-100,"maximum":100,"description":"APR threshold on a single exchange, as a fraction"}},"required":["kind","scope","direction","apr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-flip"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["negative","positive","either"]},"minApr":{"type":"number","minimum":0,"maximum":1,"description":"Rates closer to zero than this APR do not count as a flip"}},"required":["kind","scope","direction","minApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cash-and-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"reverse-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"perp-premium"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["premium","discount","either"]},"minPremium":{"type":"number","minimum":0,"maximum":1,"description":"Minimum perp premium or discount to spot, as a fraction"}},"required":["kind","scope","direction","minPremium"],"additionalProperties":false}]},"channelIds":{"type":"array","items":{"type":"string"}},"cooldownMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"minGapMinutes":{"anyOf":[{"type":"integer","minimum":5,"maximum":1440},{"type":"null"}],"description":"Most one message every this many minutes for this alert, whichever opportunities trigger it; null is off. Matches in between are still logged in the app, held, and sent together in one bundled message once the gap has passed. Not the cooldown, which is per opportunity. New alerts default to 30"},"active":{"type":"boolean"},"triggerCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastTriggeredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","name","kind","conditions","channelIds","cooldownMinutes","minGapMinutes","active","triggerCount","lastTriggeredAt","createdAt","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"post":{"operationId":"createAlert","summary":"Create an alert rule","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"conditions":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"price-arbitrage"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"market":{"type":"string","enum":["spot","perp","any"]},"minNetSpread":{"type":"number","minimum":-1,"maximum":1,"description":"Minimum net spread after taker fees, as a fraction"},"minSizeUsd":{"description":"Minimum top-of-book size in USD","type":"number","minimum":0},"minDepthUsd":{"description":"Pro: minimum order-book depth in USD that still nets a profit; only routes with a fresh depth scan can match","type":"number","minimum":0},"skipBlocked":{"description":"Leave out spot routes whose withdrawal, deposit or network is closed","type":"boolean"}},"required":["kind","scope","market","minNetSpread"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-spread"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minSpreadApr":{"type":"number","minimum":0,"maximum":100,"description":"Minimum APR spread between the chosen exchanges, as a fraction"},"includeThin":{"type":"boolean"}},"required":["kind","scope","minSpreadApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-rate"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["above","below"]},"apr":{"type":"number","minimum":-100,"maximum":100,"description":"APR threshold on a single exchange, as a fraction"}},"required":["kind","scope","direction","apr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-flip"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["negative","positive","either"]},"minApr":{"type":"number","minimum":0,"maximum":1,"description":"Rates closer to zero than this APR do not count as a flip"}},"required":["kind","scope","direction","minApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cash-and-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"reverse-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"perp-premium"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["premium","discount","either"]},"minPremium":{"type":"number","minimum":0,"maximum":1,"description":"Minimum perp premium or discount to spot, as a fraction"}},"required":["kind","scope","direction","minPremium"],"additionalProperties":false}]},"channelIds":{"default":[],"maxItems":10,"type":"array","items":{"type":"string"},"description":"Extra channels; every alert is also logged in the app"},"cooldownMinutes":{"default":60,"type":"integer","minimum":5,"maximum":1440,"description":"Minimum time between two notifications for the same opportunity"},"minGapMinutes":{"default":30,"anyOf":[{"type":"integer","minimum":5,"maximum":1440},{"type":"null"}],"description":"Most one message every this many minutes for this alert, whichever opportunities trigger it; null is off. Matches in between are still logged in the app, held, and sent together in one bundled message once the gap has passed. Not the cooldown, which is per opportunity. New alerts default to 30"},"active":{"default":true,"type":"boolean"}},"required":["name","conditions","channelIds","cooldownMinutes","minGapMinutes","active"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string"},"conditions":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"price-arbitrage"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"market":{"type":"string","enum":["spot","perp","any"]},"minNetSpread":{"type":"number","minimum":-1,"maximum":1,"description":"Minimum net spread after taker fees, as a fraction"},"minSizeUsd":{"description":"Minimum top-of-book size in USD","type":"number","minimum":0},"minDepthUsd":{"description":"Pro: minimum order-book depth in USD that still nets a profit; only routes with a fresh depth scan can match","type":"number","minimum":0},"skipBlocked":{"description":"Leave out spot routes whose withdrawal, deposit or network is closed","type":"boolean"}},"required":["kind","scope","market","minNetSpread"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-spread"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minSpreadApr":{"type":"number","minimum":0,"maximum":100,"description":"Minimum APR spread between the chosen exchanges, as a fraction"},"includeThin":{"type":"boolean"}},"required":["kind","scope","minSpreadApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-rate"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["above","below"]},"apr":{"type":"number","minimum":-100,"maximum":100,"description":"APR threshold on a single exchange, as a fraction"}},"required":["kind","scope","direction","apr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-flip"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["negative","positive","either"]},"minApr":{"type":"number","minimum":0,"maximum":1,"description":"Rates closer to zero than this APR do not count as a flip"}},"required":["kind","scope","direction","minApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cash-and-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"reverse-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"perp-premium"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["premium","discount","either"]},"minPremium":{"type":"number","minimum":0,"maximum":1,"description":"Minimum perp premium or discount to spot, as a fraction"}},"required":["kind","scope","direction","minPremium"],"additionalProperties":false}]},"channelIds":{"type":"array","items":{"type":"string"}},"cooldownMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"minGapMinutes":{"anyOf":[{"type":"integer","minimum":5,"maximum":1440},{"type":"null"}],"description":"Most one message every this many minutes for this alert, whichever opportunities trigger it; null is off. Matches in between are still logged in the app, held, and sent together in one bundled message once the gap has passed. Not the cooldown, which is per opportunity. New alerts default to 30"},"active":{"type":"boolean"},"triggerCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastTriggeredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","name","kind","conditions","channelIds","cooldownMinutes","minGapMinutes","active","triggerCount","lastTriggeredAt","createdAt","updatedAt"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/alerts/preview":{"post":{"operationId":"previewAlert","summary":"Opportunities that match a condition right now","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"conditions":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"price-arbitrage"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"market":{"type":"string","enum":["spot","perp","any"]},"minNetSpread":{"type":"number","minimum":-1,"maximum":1,"description":"Minimum net spread after taker fees, as a fraction"},"minSizeUsd":{"description":"Minimum top-of-book size in USD","type":"number","minimum":0},"minDepthUsd":{"description":"Pro: minimum order-book depth in USD that still nets a profit; only routes with a fresh depth scan can match","type":"number","minimum":0},"skipBlocked":{"description":"Leave out spot routes whose withdrawal, deposit or network is closed","type":"boolean"}},"required":["kind","scope","market","minNetSpread"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-spread"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minSpreadApr":{"type":"number","minimum":0,"maximum":100,"description":"Minimum APR spread between the chosen exchanges, as a fraction"},"includeThin":{"type":"boolean"}},"required":["kind","scope","minSpreadApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-rate"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["above","below"]},"apr":{"type":"number","minimum":-100,"maximum":100,"description":"APR threshold on a single exchange, as a fraction"}},"required":["kind","scope","direction","apr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-flip"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["negative","positive","either"]},"minApr":{"type":"number","minimum":0,"maximum":1,"description":"Rates closer to zero than this APR do not count as a flip"}},"required":["kind","scope","direction","minApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cash-and-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"reverse-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"perp-premium"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["premium","discount","either"]},"minPremium":{"type":"number","minimum":0,"maximum":1,"description":"Minimum perp premium or discount to spot, as a fraction"}},"required":["kind","scope","direction","minPremium"],"additionalProperties":false}]}},"required":["conditions"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"matches":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"kind":{"type":"string"},"coin":{"type":"string"},"value":{"type":"number"},"label":{"type":"string"},"summary":{"type":"string"},"path":{"type":"string"},"legs":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["buy","sell","long","short"]},"exchange":{"type":"string"},"detail":{"type":"string"},"url":{"description":"Exchange market page for this leg","type":"string"}},"required":["role","exchange","detail"],"additionalProperties":false}}},"required":["key","kind","coin","value","label","summary","path","legs"],"additionalProperties":false}}},"required":["total","matches"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/alerts/{id}":{"patch":{"operationId":"updateAlert","summary":"Edit, pause or resume an alert rule","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":80},"conditions":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"price-arbitrage"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"market":{"type":"string","enum":["spot","perp","any"]},"minNetSpread":{"type":"number","minimum":-1,"maximum":1,"description":"Minimum net spread after taker fees, as a fraction"},"minSizeUsd":{"description":"Minimum top-of-book size in USD","type":"number","minimum":0},"minDepthUsd":{"description":"Pro: minimum order-book depth in USD that still nets a profit; only routes with a fresh depth scan can match","type":"number","minimum":0},"skipBlocked":{"description":"Leave out spot routes whose withdrawal, deposit or network is closed","type":"boolean"}},"required":["kind","scope","market","minNetSpread"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-spread"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minSpreadApr":{"type":"number","minimum":0,"maximum":100,"description":"Minimum APR spread between the chosen exchanges, as a fraction"},"includeThin":{"type":"boolean"}},"required":["kind","scope","minSpreadApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-rate"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["above","below"]},"apr":{"type":"number","minimum":-100,"maximum":100,"description":"APR threshold on a single exchange, as a fraction"}},"required":["kind","scope","direction","apr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-flip"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["negative","positive","either"]},"minApr":{"type":"number","minimum":0,"maximum":1,"description":"Rates closer to zero than this APR do not count as a flip"}},"required":["kind","scope","direction","minApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cash-and-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"reverse-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"perp-premium"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["premium","discount","either"]},"minPremium":{"type":"number","minimum":0,"maximum":1,"description":"Minimum perp premium or discount to spot, as a fraction"}},"required":["kind","scope","direction","minPremium"],"additionalProperties":false}]},"channelIds":{"maxItems":10,"type":"array","items":{"type":"string"},"description":"Extra channels; every alert is also logged in the app"},"cooldownMinutes":{"type":"integer","minimum":5,"maximum":1440,"description":"Minimum time between two notifications for the same opportunity"},"minGapMinutes":{"anyOf":[{"type":"integer","minimum":5,"maximum":1440},{"type":"null"}],"description":"Most one message every this many minutes for this alert, whichever opportunities trigger it; null is off. Matches in between are still logged in the app, held, and sent together in one bundled message once the gap has passed. Not the cooldown, which is per opportunity. New alerts default to 30"},"active":{"type":"boolean"}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string"},"conditions":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"price-arbitrage"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"market":{"type":"string","enum":["spot","perp","any"]},"minNetSpread":{"type":"number","minimum":-1,"maximum":1,"description":"Minimum net spread after taker fees, as a fraction"},"minSizeUsd":{"description":"Minimum top-of-book size in USD","type":"number","minimum":0},"minDepthUsd":{"description":"Pro: minimum order-book depth in USD that still nets a profit; only routes with a fresh depth scan can match","type":"number","minimum":0},"skipBlocked":{"description":"Leave out spot routes whose withdrawal, deposit or network is closed","type":"boolean"}},"required":["kind","scope","market","minNetSpread"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-spread"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minSpreadApr":{"type":"number","minimum":0,"maximum":100,"description":"Minimum APR spread between the chosen exchanges, as a fraction"},"includeThin":{"type":"boolean"}},"required":["kind","scope","minSpreadApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-rate"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["above","below"]},"apr":{"type":"number","minimum":-100,"maximum":100,"description":"APR threshold on a single exchange, as a fraction"}},"required":["kind","scope","direction","apr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-flip"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["negative","positive","either"]},"minApr":{"type":"number","minimum":0,"maximum":1,"description":"Rates closer to zero than this APR do not count as a flip"}},"required":["kind","scope","direction","minApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cash-and-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"reverse-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"perp-premium"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["premium","discount","either"]},"minPremium":{"type":"number","minimum":0,"maximum":1,"description":"Minimum perp premium or discount to spot, as a fraction"}},"required":["kind","scope","direction","minPremium"],"additionalProperties":false}]},"channelIds":{"type":"array","items":{"type":"string"}},"cooldownMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"minGapMinutes":{"anyOf":[{"type":"integer","minimum":5,"maximum":1440},{"type":"null"}],"description":"Most one message every this many minutes for this alert, whichever opportunities trigger it; null is off. Matches in between are still logged in the app, held, and sent together in one bundled message once the gap has passed. Not the cooldown, which is per opportunity. New alerts default to 30"},"active":{"type":"boolean"},"triggerCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastTriggeredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","name","kind","conditions","channelIds","cooldownMinutes","minGapMinutes","active","triggerCount","lastTriggeredAt","createdAt","updatedAt"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}},"delete":{"operationId":"deleteAlert","summary":"Delete an alert rule and its history","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string"},"conditions":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","const":"price-arbitrage"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"market":{"type":"string","enum":["spot","perp","any"]},"minNetSpread":{"type":"number","minimum":-1,"maximum":1,"description":"Minimum net spread after taker fees, as a fraction"},"minSizeUsd":{"description":"Minimum top-of-book size in USD","type":"number","minimum":0},"minDepthUsd":{"description":"Pro: minimum order-book depth in USD that still nets a profit; only routes with a fresh depth scan can match","type":"number","minimum":0},"skipBlocked":{"description":"Leave out spot routes whose withdrawal, deposit or network is closed","type":"boolean"}},"required":["kind","scope","market","minNetSpread"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-spread"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minSpreadApr":{"type":"number","minimum":0,"maximum":100,"description":"Minimum APR spread between the chosen exchanges, as a fraction"},"includeThin":{"type":"boolean"}},"required":["kind","scope","minSpreadApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-rate"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["above","below"]},"apr":{"type":"number","minimum":-100,"maximum":100,"description":"APR threshold on a single exchange, as a fraction"}},"required":["kind","scope","direction","apr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"funding-flip"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["negative","positive","either"]},"minApr":{"type":"number","minimum":0,"maximum":1,"description":"Rates closer to zero than this APR do not count as a flip"}},"required":["kind","scope","direction","minApr"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"cash-and-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"reverse-carry"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"minApr":{"type":"number","minimum":-10,"maximum":100,"description":"Minimum estimated APR after basis and fees, as a fraction"},"holdDays":{"anyOf":[{"type":"number","const":7},{"type":"number","const":30},{"type":"number","const":90}]},"sameExchange":{"type":"boolean"}},"required":["kind","scope","minApr","holdDays"],"additionalProperties":false},{"type":"object","properties":{"kind":{"type":"string","const":"perp-premium"},"scope":{"type":"object","properties":{"exchanges":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{"type":"string","maxLength":40}}},"required":["include","exclude"],"additionalProperties":false,"description":"Exchange ids; include limits the alert to these venues"},"coins":{"type":"object","properties":{"include":{"default":[],"maxItems":60,"type":"array","items":{}},"exclude":{"default":[],"maxItems":60,"type":"array","items":{}}},"required":["include","exclude"],"additionalProperties":false}},"required":["exchanges","coins"],"additionalProperties":false},"followWatchlist":{"description":"Run on your watchlist as it is at each check instead of scope.coins.include; an empty watchlist matches nothing","type":"boolean"},"minVolumeUsd":{"description":"Minimum 24h volume of each leg in USD","type":"number","minimum":0},"minOpenMinutes":{"description":"Only alert once an opportunity has stayed open this many minutes without closing","type":"integer","minimum":0,"maximum":240},"quietHours":{"description":"Pro: no alerts between these hours (0-23) in the given IANA time zone; the window may wrap midnight","type":"object","properties":{"from":{"type":"integer","minimum":0,"maximum":23},"to":{"type":"integer","minimum":0,"maximum":23},"timeZone":{"type":"string","maxLength":64}},"required":["from","to","timeZone"],"additionalProperties":false},"direction":{"type":"string","enum":["premium","discount","either"]},"minPremium":{"type":"number","minimum":0,"maximum":1,"description":"Minimum perp premium or discount to spot, as a fraction"}},"required":["kind","scope","direction","minPremium"],"additionalProperties":false}]},"channelIds":{"type":"array","items":{"type":"string"}},"cooldownMinutes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"minGapMinutes":{"anyOf":[{"type":"integer","minimum":5,"maximum":1440},{"type":"null"}],"description":"Most one message every this many minutes for this alert, whichever opportunities trigger it; null is off. Matches in between are still logged in the app, held, and sent together in one bundled message once the gap has passed. Not the cooldown, which is per opportunity. New alerts default to 30"},"active":{"type":"boolean"},"triggerCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastTriggeredAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"required":["id","name","kind","conditions","channelIds","cooldownMinutes","minGapMinutes","active","triggerCount","lastTriggeredAt","createdAt","updatedAt"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/alert-events":{"get":{"operationId":"listAlertEvents","summary":"Alert history: every trigger with its opportunities and delivery results","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[{"name":"alertId","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"string"}},{"name":"before","in":"query","required":false,"description":"Return events older than this event id","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Return events older than this event id","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},{"name":"limit","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"integer","minimum":1,"maximum":100}},{"name":"unread","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"alertId":{"type":"string"},"alertName":{"type":"string"},"kind":{"type":"string"},"headline":{"type":"string"},"matches":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"kind":{"type":"string"},"coin":{"type":"string"},"value":{"type":"number"},"label":{"type":"string"},"summary":{"type":"string"},"path":{"type":"string"},"legs":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["buy","sell","long","short"]},"exchange":{"type":"string"},"detail":{"type":"string"},"url":{"description":"Exchange market page for this leg","type":"string"}},"required":["role","exchange","detail"],"additionalProperties":false}}},"required":["key","kind","coin","value","label","summary","path","legs"],"additionalProperties":false}},"read":{"type":"boolean"},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"feedback":{"anyOf":[{"type":"string","enum":["up","down"]},{"type":"null"}],"description":"The member's own thumb on this entry; null when not rated"},"deliveries":{"type":"array","items":{"type":"object","properties":{"channel":{"type":"string"},"kind":{"type":"string","enum":["telegram","webhook","email","browser"]},"status":{"type":"string","enum":["sent","failed","skipped","held","paced","bundled"],"description":"sent, failed or skipped are final. held waits for the channel limit and paced for the alert minimum gap; both end as bundled once a bundled message or summary carried them"},"error":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},"bundledAt":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}],"description":"When a held delivery went out in a bundled message or summary"},"latencyMs":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Milliseconds from match detected to sent; null when not measured"}},"required":["channel","kind","status","error","createdAt","bundledAt","latencyMs"],"additionalProperties":false}}},"required":["id","alertId","alertName","kind","headline","matches","read","createdAt","feedback","deliveries"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/alert-events/unread":{"get":{"operationId":"getAlertInbox","summary":"Number of unread alert events","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"unread":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"latest":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}]}},"required":["unread","latest"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/alert-events/read":{"post":{"operationId":"markAlertEventsRead","summary":"Mark alert events as read; all when no ids are given","tags":["Alerts"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"ids":{"maxItems":200,"type":"array","items":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}},"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"unread":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"latest":{"anyOf":[{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"type":"null"}]}},"required":["unread","latest"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/tools/arbitrage-map":{"get":{"operationId":"getArbitrageMap","summary":"Every executable price route right now, exchange to exchange, for the arbitrage map","tags":["Pro tools"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"exchanges":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"routes":{"type":"array","items":{"type":"object","properties":{"coin":{"type":"string"},"slug":{"type":"string"},"type":{"type":"string","enum":["spot","perp"]},"buy":{"type":"string"},"sell":{"type":"string"},"buyPrice":{"type":"number"},"sellPrice":{"type":"number"},"netSpread":{"type":"number","description":"Net spread after taker fees, as a fraction"},"volumeUsd":{"type":"number","description":"24h volume of the thinner leg"}},"required":["coin","slug","type","buy","sell","buyPrice","sellPrice","netSpread","volumeUsd"],"additionalProperties":false}},"tracks":{"type":"array","items":{"type":"object","properties":{"buy":{"type":"string"},"sell":{"type":"string"},"type":{"type":"string","enum":["spot","perp"]}},"required":["buy","sell","type"],"additionalProperties":false}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"updatedAt":{"type":"number"}},"required":["exchanges","routes","tracks","total","updatedAt"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/tools/funding-compare":{"get":{"operationId":"getFundingCompare","summary":"Hourly funding history of up to five coins or coin-exchange markets on one chart","tags":["Pro tools"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[{"name":"series","in":"query","required":false,"description":"Up to five comma-separated series: a coin (BTC) or a coin on one exchange (BTC@binance)","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"string","maxLength":200,"description":"Up to five comma-separated series: a coin (BTC) or a coin on one exchange (BTC@binance)"}},{"name":"days","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string"},"coin":{"type":"string"},"exchange":{"type":"string"},"label":{"type":"string"},"points":{"type":"array","items":{"type":"object","properties":{"time":{"type":"number"},"value":{"type":"number","description":"APR"}},"required":["time","value"],"additionalProperties":false}},"exchanges":{"type":"array","items":{"type":"string"}}},"required":["key","coin","label","points","exchanges"],"additionalProperties":false}},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}},"/api/v1/me/tools/funding-timeline":{"get":{"operationId":"getFundingTimeline","summary":"A funding pair projected forward at current rates: each payment, the running total and break-even","tags":["Pro tools"],"security":[{"apiKey":[]},{"bearer":[]},{"cookie":[]}],"parameters":[{"name":"coin","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"string","minLength":1,"maxLength":20}},{"name":"short","in":"query","required":false,"description":"Exchange to short (receives positive funding); the highest rate by default","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Exchange to short (receives positive funding); the highest rate by default","type":"string"}},{"name":"long","in":"query","required":false,"description":"Exchange to go long on; the lowest rate by default","schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","description":"Exchange to go long on; the lowest rate by default","type":"string"}},{"name":"size","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"number","exclusiveMinimum":0,"maximum":10000000}},{"name":"hours","in":"query","required":false,"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"object","properties":{"coin":{"type":"string"},"slug":{"type":"string"},"sizeUsd":{"type":"number"},"hours":{"type":"number"},"start":{"type":"number"},"short":{"type":"object","properties":{"exchange":{"type":"string"},"name":{"type":"string"},"rate":{"type":"number"},"intervalHours":{"type":"number"},"times":{"type":"array","items":{"type":"number"}}},"required":["exchange","name","rate","intervalHours","times"],"additionalProperties":false},"long":{"type":"object","properties":{"exchange":{"type":"string"},"name":{"type":"string"},"rate":{"type":"number"},"intervalHours":{"type":"number"},"times":{"type":"array","items":{"type":"number"}}},"required":["exchange","name","rate","intervalHours","times"],"additionalProperties":false},"venues":{"type":"array","items":{"type":"object","properties":{"exchange":{"type":"string"},"name":{"type":"string"},"rate":{"type":"number"},"intervalHours":{"type":"number"},"times":{"type":"array","items":{"type":"number"}}},"required":["exchange","name","rate","intervalHours","times"],"additionalProperties":false}},"payments":{"type":"array","items":{"type":"object","properties":{"time":{"type":"number"},"exchange":{"type":"string"},"side":{"type":"string","enum":["short","long"]},"amountUsd":{"type":"number"}},"required":["time","exchange","side","amountUsd"],"additionalProperties":false}},"cumulative":{"type":"array","items":{"type":"object","properties":{"time":{"type":"number"},"valueUsd":{"type":"number"}},"required":["time","valueUsd"],"additionalProperties":false}},"feesUsd":{"type":"number"},"breakEvenAt":{"type":"number"}},"required":["coin","slug","sizeUsd","hours","start","short","long","venues","payments","cumulative","feesUsd"],"additionalProperties":false},"meta":{"type":"object","properties":{"updatedAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"}},"additionalProperties":false}},"required":["data","meta"],"additionalProperties":false}}}},"default":{"description":"Error","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false}}}}}}}}}