google-events-scraper v1.0.10

Google Events Scraper

Scraper to gather data from google events using Crawlee made in Typescript.

Installation & Usage

To install use the following npm command

$ npm install google-events-scraper

Once installed it's simple as creating an object and using it

import gEventsScraper from 'google-events-scraper';

const scraper = new gEventsScraper();
const results = await scraper.Scrape('events new york');

Date

There are two ways you can specify the date of the event but keep in mind that sometimes it will still show events outside of that range due to google.

You can specify it in the query:

const results = await scraper.Scrape('events today'); //This seems to not work so well
const results = await scraper.Scrape('events next week');
const results = await scraper.Scrape('events december 2023');

Or you can use the optional date parameters (this uses google's own way of checking the date but it's very limited, this example provides all the options):

const results = await scraper.Scrape('events canada', { today:true });
const results = await scraper.Scrape('events canada', { tomorrow:true });
const results = await scraper.Scrape('events canada', { thisWeek:true });
const results = await scraper.Scrape('events canada', { thisWeekend:true });
const results = await scraper.Scrape('events canada', { nextWeek:true });
const results = await scraper.Scrape('events canada', { nextMonth:true });

Results

If by any chance you want the last results of the scraper you can use this function (make sure it has ran at least once):

const results2 = scraper.GetResults();

IMPORTANT: start & end time given is in the UTC timezone so when using Date objects for example make sure you always get it in UTC for example 'time.getUTCTime();'. otherwise it will use your local time zone and convert the time to your time zone displaying something completely incorrect. BUT just because you're using it in the UTC timezone does not mean the events time is acctually in UTC (I'm just using that timezone as a basis). If the scraper does find a timezone you can check it but sometimes you can't find it and most of the information has to be inferred from a string.

The results you will recieve and some things to keep in mind:

{
    name: 'Event Name',
    description: 'Event Description', //Has possibility of being empty
    imageUrl: 'https://image.url', //Has possibility of being empty
    mapImageUrl: 'https://map-image.url',
    date: { 
        start: 1686841200,
        end: 1686909600, //Has possibility of being 0
        timezone: 'UTC', //Has possibility of being empty
        when: 'Today' }, //Has possibility of being empty
    location: {
      name: 'Location Name',
      address: 'Location Address',
      mapUrl: 'https://google-maps.url'
    },
    links: [ { //Array containing one or more links to buy tickets and such
        name: 'Event Website',
        url: 'https://event.url'
    } ]
}

Notes

This should be able to scrape most of the events and not break, but the way google events displays data isn't the most predictable thing and although I tried getting all the cases it might still break. If such thing happens feel free to create an issue.

Not only this is my first proper package it's also my first time using Typescript so if you have any questions, suggestions or know how to improve it feel free to offer the suggestion or fork this repository and create a pull request!