Pingem SDK

Lightweight event tracking for Farcaster-connected apps.

Register your Mini App

Assuming you have a working Farcaster Mini App, visit https://analytics.pingem.xyz and register your Mini App domain.

Install

npm install pingem-sdk

Quickstart

import { Pingem } from 'pingem-sdk';
import { sdk } from '@farcaster/frame-sdk';

const pingem = new Pingem();
await sdk.actions.ready();
await pingem.init(sdk, 'your-mini-app-domain');
await sdk.actions.addFrame();
await pingem.ping('view');

If you have a static website, you probably import the frame-sdk.

Modify it like this:

<script type="module">
  import { sdk } from '@farcaster/frame-sdk'; 
  import { Pingem } from 'https://esm.sh/pingem-sdk'; // Import pingem-sdk

  const pingem = new Pingem(); // Create a new instance
  await sdk.actions.ready();
  await pingem.init(sdk, 'your-mini-app-domain'); // After the sdk is initailized, init pingem
  await pingem.ping('view'); // Send data to the pingem service
</script>