Redis API Endpoints

This section documents all Redis Endpoints for real-time time data retrieval.

🔍 Pokéstops

• Endpoint: /api/redis/get_cached_pokestops

• Description:

  • Retrieves all Pokéstops counts per Area based on your Koji Geofences from Golbat SQL Database.

• Examples:

🌐 Koji Geofences

• Endpoint: /api/redis/get_cached_geofences

• Description:

  • Retrieves all Areas Geofences with name, coordinates and timezone offset.

• Examples:

👻 Pokémon Counter Series

• Endpoint: /api/redis/get_pokemon_counterseries

• Description:

  • Retrieves counter series for Pokémon (totals, time-to-hatch (TTH), and weather counters) with configurable intervals (hourly, weekly, or monthly).

• Query Parameters:

  • counter_type :

    • totals (Pokémon totals per id/form if specified per Area or Global).

    • tth (Provides information into time ranges/buckets for each Pokémon Despawn Timer Per Area or Global).

    • weather (Aggregates Pokémon information into IV ranges/buckets and their total number for each type of weather condition per Area or Global).

  • interval:

    • hourly

    • weekly

    • monthly - weather only

  • start_time, end_time ISO or relative times) addressed here.

  • mode (sum, grouped, surged - note: surged only works with hourly).

  • area (e.g., global or specific area from your Koji Geofences).

  • metric:

    • Totals: iv100, iv0, pvp_little, pvp_great, pvp_ultra, shiny.

    • Weather: Based on pogo data 0-9I think.

    • TTH: allowed values are e.g. 0_5, 5_10, etc.

  • pokemon_id (all or specific Pokémon ID).

  • form (all or specific form ID).

  • response_format (json, text).

• Examples & Response Formats:

👹 Raid Counter Series

• Endpoint: /api/redis/get_raids_counterseries

• Description:

  • Retrieves raid counter series (totals) with options for hourly or weekly aggregation.

• Query Parameters:

  • Similar to the Pokémon endpoint.

  • Specific parameters:

    • raid_pokemon (Raid Pokémon ID or all)

    • raid_form (Raid Pokémon Form ID or all)

    • raid_level (Raid level or all)

    • raid_costume (Raid Pokémon Costume ID or all)

    • raid_is_exclusive (Raid Exclusive 0 - 1 or all)

    • raid_ex_eligible (Raid Ex Eligible 0 - 1 or all)

• Examples:

🕴️ Invasion Counter Series

• Endpoint: /api/redis/get_invasions_counterseries

• Description:

  • Retrieves invasion counter series (totals) for hourly or weekly intervals.

• Query Parameters:

  • Similar to all other Counter Series.

  • Specific parameters:

    • display_type Invasion Display Type ID or all

    • character Invasion Character ID or all

    • grunt Invasion Grunt ID or all

    • confirmed Line-up confirmed, 0 - 1 or all

• Examples:

🔎 Quest Counter Series

• Endpoint: /api/redis/get_quest_counterseries

• Description:

  • Retrievies Quest Counter Series (totals) aggregated hourly or weekly.

• Query Parameters:

  • Similar to all other Counter Series.

  • Specific parameters:

    • with_ar true(AR),false(Normal) or all

    • reward types based in AR or Normal:

      • _type Quest Type ID or all

      • _item_id Quest Item ID or all

      • _item_amount Quest Item Amount or all

      • _poke_id Quest Pokémon ID or all

      • _poke_form Quest Pokémon Form or all

• Examples:

👻 Pokémon TimeSeries

• Endpoint: /api/redis/get_pokemon_timeseries

• Description:

  • Provides timeseries data for Pokémon counters filtered by Pokémon ID and form.

• Query Parameters:

  • Similar to Counter Series, except there are no Counter Type.

  • Query for individual Pokémons and their forms.

• Examples:

👻 Pokémon TTH TimeSeries

• Endpoint: /api/redis/get_pokemon_tth_timeseries

• Description:

  • Retrieves timeseries data for time-to-hour (TTH) values with filtering for specific TTH buckets/ranges.

• Query Parameters:

  • Similar to Counter Series.

• Examples:

👹 Raid TimeSeries

• Endpoint: /api/redis/get_raid_timeseries

• Description:

  • Retrieves timeseries data for raids, allowing filtering by raid Pokémon, form and level.

• Query Parameters:

  • Similar to Counter Series.

  • Query for individual pokémons/forms and raid levels.

• Examples:

🕴️Invasion TimeSeries

• Endpoint: /api/redis/get_invasion_timeseries

• Description:

  • Provides timeseries data for invasions allowing filtering by display, grunt and confirmed.

• Query Parameters:

  • Similar to Counter Series.

  • Additions:

    • display

    • grunt

    • confirmed

  • Allows you to query for individual display type, grunt and if their line ups have been confirmed.

• Examples:

🔎 Quest TimeSeries

• Endpoint: /api/redis/get_quest_timeseries

• Description:

  • Provides timeseries data for quests, allowing filtering based on quest mode and type.

• Query Parameters:

  • Similar to Counter Series.

  • Additions:

    • quest_mode

    • quest_type

  • Allows you to query for individual quest_mode and quest_type.

• Examples: