FishFish API v1 Documentation

This documentation covers how to make requests to every FishFish API endpoint. Some endpoints listed are not available for public use. Typically, only endpoints using the GET HTTP verb are public. The current base URL including version is https://api.fishfish.gg/v1.

Authentication

Routes or parameters requiring authentication are notated with Auth. Many requests to the FishFish API require authentication via an API key for the purposes of anti-abuse. You can obtain an API key by running the /key command in the FishFish Discord server. There are two types of authentication token used by the FishFish API. The first is your main token, as given by the FishFish bot, which can only be used to acquire session tokens. Tokens should be sent in the Authorization header of authenticated requests.

The second type of token is a session token, which is used to authenticate the majority of requests to the API. Session tokens are acquired by sending a POST request to the /users/@me/tokens endpoint with your main token in the Authorization header. Session tokens are valid for one hour. After they have expired you must acquire a new session token to continue making requests. Session tokens should be sent in the Authorization header of authenticated requests.

WebSocket API

We provide live updates to our database via a WebSocket feed. The WebSocket feed can be found at wss://api.fishfish.gg/v1/stream. This endpoint is authenticated. Please provide an API session token header when connecting to the API.

Recommended Behaviour

In order to prevent unnecessary spam to our API, it is not recommended to exclusively pull our entire domain/URL lists. Instead, recommended behavior (for example, with a Discord bot) is to pull the domain/url lists at startup, then subscribe to the feed for live updates. For redundancy, optionally pull the domain/URL lists periodically to catch potentially-missed events (recommended to do this hourly-daily).