Gravatar For Developers

https://docs.gravatar.com/
Admin
Gravatar provides developers with APIs and SDKs to leverage rich user profile data, including...
Tokens:46,545
Snippets:228
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Start Application

Source: https://docs.gravatar.com/guides/tutorial-user-profile

Command to start the Node.js application after setup.

```bash
npm start
```

--------------------------------

### Start Application

Source: https://docs.gravatar.com/api/profiles/tutorial-user-profile

Command to start the Node.js application after setup.

```bash
npm start
```

--------------------------------

### Install Gravatar React Profile Example

Source: https://docs.gravatar.com/api/profiles/tutorial-user-profile

Uses npx to create a new project skeleton for a Gravatar profile card component. Prompts user to choose between a complete or starter application.

```bash
npx create-gravatar-react-profile-example <project-name>
```

--------------------------------

### Install Gravatar React Profile Example

Source: https://docs.gravatar.com/guides/tutorial-user-profile

Uses npx to create a new project skeleton for a Gravatar profile card component. Prompts user to choose between a complete or starter application.

```bash
npx create-gravatar-react-profile-example <project-name>
```

--------------------------------

### Gravatar Guides and Developer Tools

Source: https://docs.gravatar.com/api

Resources for developers, including guides on user profile tutorials, using Gravatar for live events, example integrations, and AI assistant usage. Also lists developer tools like the dashboard and GitHub repositories.

```APIDOC
Guides:
  - User profile tutorial (React): https://docs.gravatar.com/guides/tutorial-user-profile/
  - Gravatar for live events: https://docs.gravatar.com/guides/qr-code-badges/
  - Example integrations: https://docs.gravatar.com/guides/integrations/
  - Use with AI assistants: https://docs.gravatar.com/guides/llms-txt/

Developer Tools:
  - Developer dashboard: https://gravatar.com/developers
  - GitHub repos: https://github.com/Automattic/gravatar
  - WordPress plugin: https://wordpress.org/plugins/gravatar-enhanced/
  - Feature requests: https://github.com/Automattic/gravatar/discussions/categories/ideas
  - Give feedback: https://github.com/Automattic/gravatar/discussions
```

--------------------------------

### Create Gravatar React Profile Example

Source: https://docs.gravatar.com/api/profiles/tutorial-user-profile

A command-line interface (CLI) command to quickly set up a new React project pre-configured for integrating Gravatar user profiles. This simplifies the initial project setup for developers.

```bash
npx create-gravatar-react-profile-example <project-name>
```

--------------------------------

### Create Gravatar React Profile Example

Source: https://docs.gravatar.com/guides/tutorial-user-profile

A command-line interface (CLI) command to quickly set up a new React project pre-configured for integrating Gravatar user profiles. This simplifies the initial project setup for developers.

```bash
npx create-gravatar-react-profile-example <project-name>
```

--------------------------------

### Add Gravatar Maven Repositories

Source: https://docs.gravatar.com/mobile-sdk/android-sdk

Configures the necessary Maven repositories in the root `build.gradle` file to fetch the Gravatar SDK and its dependencies like uCrop.

```Gradle
repositories {
    maven {
        url "https://a8c-libs.s3.amazonaws.com/android"
    }
    // Jitpack is used to fetch the uCrop library. Required only for gravatar-ui module.
    maven {
        url "https://jitpack.io"
        content {
            includeModule("com.github.yalantis", "ucrop")
        }
    }
}
```

--------------------------------

### Configure API Key from local.properties

Source: https://docs.gravatar.com/mobile-sdk/android-sdk

Reads the Gravatar API key from `local.properties` and exposes it via the `BuildConfig` class for secure access in your Android application.

```Kotlin
android {
    buildFeatures.buildConfig = true

    val properties = Properties()
    properties.load(FileInputStream(project.rootProject.file("local.properties")))
    buildConfigField("String", "GRAVATAR_API_KEY", "\"${properties["gravatar.api.key"]}\"")
}
```

--------------------------------

### Gravatar REST API Overview

Source: https://docs.gravatar.com/api/profiles/tutorial-user-profile

Provides an overview of the Gravatar REST API, including sections on getting started, authentication, creating user identifiers (hashes), and detailed API data specifications covering endpoints and data models.

```APIDOC
Gravatar REST API:
  - Getting started: https://docs.gravatar.com/rest/getting-started/
  - Authentication: https://docs.gravatar.com/rest/authentication/
  - Creating identifier (hash): https://docs.gravatar.com/rest/hash/
  - API data specifications: https://docs.gravatar.com/rest/api-data-specifications/
    - Endpoints references: https://docs.gravatar.com/rest/api-data-specifications/endpoints-references/
    - Data models: https://docs.gravatar.com/rest/api-data-specifications/data-models/
```

--------------------------------

### Initialize Gravatar SDK

Source: https://docs.gravatar.com/mobile-sdk/android-sdk

Initializes the Gravatar SDK in your Android application using the API key obtained from `BuildConfig`. This is typically done in your main activity or application class.

```Kotlin
Gravatar.initialize(BuildConfig.GRAVATAR_API_KEY)
```

--------------------------------

### Gravatar REST API Overview

Source: https://docs.gravatar.com/guides/tutorial-user-profile

Provides an overview of the Gravatar REST API, including sections on getting started, authentication, creating user identifiers (hashes), and detailed API data specifications covering endpoints and data models.

```APIDOC
Gravatar REST API:
  - Getting started: https://docs.gravatar.com/rest/getting-started/
  - Authentication: https://docs.gravatar.com/rest/authentication/
  - Creating identifier (hash): https://docs.gravatar.com/rest/hash/
  - API data specifications: https://docs.gravatar.com/rest/api-data-specifications/
    - Endpoints references: https://docs.gravatar.com/rest/api-data-specifications/endpoints-references/
    - Data models: https://docs.gravatar.com/rest/api-data-specifications/data-models/
```

--------------------------------

### Get Gravatar Profile (Curl Example)

Source: https://docs.gravatar.com/rest/api-data-specifications/endpoints-references

Example using curl to fetch a user's Gravatar profile by their identifier, including authentication headers.

```bash
curl -X GET "https://api.gravatar.com/v3/profiles/84059b07d4be67b806386c0aad8070a23f18836bbaae342275dc0a83414c32ee" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### Add Gravatar SDK Dependencies

Source: https://docs.gravatar.com/mobile-sdk/android-sdk

Adds the core Gravatar SDK and the UI module dependencies to your module's `build.gradle` file. Replace `<version>` with the latest release tag.

```Gradle
dependencies {
    implementation ("com.gravatar:gravatar:<version>")
    implementation ("com.gravatar:gravatar-ui:<version>")
}
```

--------------------------------

### Sample Gravatar API Call

Source: https://docs.gravatar.com/api/rest-api

Example of how to make a GET request to retrieve a Gravatar profile using cURL, including an authorization header.

```curl
curl -X GET "https://api.gravatar.com/v3/profiles/{profileIdentifier}" -H "Authorization: Bearer $GRAVATAR_API_KEY"
```

--------------------------------

### Gravatar Android SDK Installation

Source: https://docs.gravatar.com/guides/llms-txt

Steps to integrate the Gravatar Android SDK into your project. This includes adding Maven repositories, dependencies, and initializing the SDK with an API key.

```Gradle
repositories {
    maven {
        url "https://a8c-libs.s3.amazonaws.com/android"
    }
    maven {
        url "https://jitpack.io"
        content {
            includeModule("com.github.yalantis", "ucrop")
        }
    }
}

dependencies {
    implementation ("com.gravatar:gravatar:<version>")
    implementation ("com.gravatar:gravatar-ui:<version>")
}
```

--------------------------------

### Gravatar REST API Overview

Source: https://docs.gravatar.com/guides/llms-txt

Provides an overview of the Gravatar REST API, including getting started, authentication, creating identifiers (hashes), and API data specifications. It links to endpoint references and data models.

```APIDOC
Gravatar REST API Documentation v3.0.0

Key Sections:
- Getting started: https://docs.gravatar.com/rest/getting-started/
- Authentication: https://docs.gravatar.com/rest/authentication/
- Creating identifier (hash): https://docs.gravatar.com/rest/hash/
- API data specifications: https://docs.gravatar.com/rest/api-data-specifications/
  - Endpoints references: https://docs.gravatar.com/rest/api-data-specifications/endpoints-references/
  - Data models: https://docs.gravatar.com/rest/api-data-specifications/data-models/

API Explorer (console): https://gravatar.com/developers/console ↗
```

--------------------------------

### Install Gravatar Quick Editor

Source: https://docs.gravatar.com/guides/quickeditor

Install the Gravatar Quick Editor JavaScript library using npm or yarn package managers to add its functionality to your project.

```bash
npm install @gravatar-com/quick-editor
```

```bash
yarn add @gravatar-com/quick-editor
```

--------------------------------

### Install Gravatar Quick Editor

Source: https://docs.gravatar.com/sdk/quickeditor

Install the Gravatar Quick Editor JavaScript library using npm or yarn package managers to add its functionality to your project.

```bash
npm install @gravatar-com/quick-editor
```

```bash
yarn add @gravatar-com/quick-editor
```

--------------------------------

### Install Gravatar Quick Editor

Source: https://docs.gravatar.com/guides/llms-txt

Installs the Gravatar Quick Editor JavaScript component using npm. This is the first step to integrate the editor into a web application.

```bash
npm install @gravatar-com/quick-editor
```

--------------------------------

### Usage with GravatarQuickEditor Class

Source: https://docs.gravatar.com/guides/quickeditor

Demonstrates initializing the `GravatarQuickEditor` class. This class simplifies setup by automatically handling event listeners for opening the popup and updating avatar elements on the page based on provided selectors.

```javascript
import { GravatarQuickEditor } from '@gravatar-com/quick-editor';

document.addEventListener( 'DOMContentLoaded', () => {
  new GravatarQuickEditor( {
    email: 'user@example.com',
    editorTriggerSelector: '#edit-profile',
    avatarSelector: '#gravatar-avatar',
    scope: [ 'avatars' ],
  } );
} );
```

--------------------------------

### Usage with GravatarQuickEditor Class

Source: https://docs.gravatar.com/sdk/quickeditor

Demonstrates initializing the `GravatarQuickEditor` class. This class simplifies setup by automatically handling event listeners for opening the popup and updating avatar elements on the page based on provided selectors.

```javascript
import { GravatarQuickEditor } from '@gravatar-com/quick-editor';

document.addEventListener( 'DOMContentLoaded', () => {
  new GravatarQuickEditor( {
    email: 'user@example.com',
    editorTriggerSelector: '#edit-profile',
    avatarSelector: '#gravatar-avatar',
    scope: [ 'avatars' ],
  } );
} );
```

--------------------------------

### Gravatar REST API Overview

Source: https://docs.gravatar.com/avatars/javascript

Provides an overview of the Gravatar REST API, including sections on getting started, authentication methods, the process of creating an identifier (hash) from an email address, and API data specifications covering endpoints and data models.

```APIDOC
Gravatar REST API:

Overview:
  - Getting Started: Information on initial setup and usage.
  - Authentication: Details on how to authenticate API requests.
  - Creating Identifier (Hash): Process for generating a unique identifier from an email address using hashing (e.g., SHA-256).
  - API Data Specifications:
    - Endpoints References: Documentation for available API endpoints.
    - Data Models: Definitions of data structures used by the API.

API Explorer:
  - Provides a console for interacting with the Gravatar API.
```

--------------------------------

### Fetch Gravatar Profile Data (JavaScript)

Source: https://docs.gravatar.com/guides/llms-txt

Provides an example of how to retrieve detailed user profile information from the Gravatar API. It shows constructing the profile URL and making an authenticated GET request using a Bearer token.

```javascript
const hash = getGravatarHash('user@example.com');

const profileUrl = `https://api.gravatar.com/v3/profiles/${hash}`;

// With authentication (recommended)
fetch(profileUrl, {

  headers: {

    'Authorization': 'Bearer YOUR_API_KEY'

  }

})

.then(response => response.json())

.then(profile => console.log(profile));
```

--------------------------------

### Install Gravatar Hovercards Library

Source: https://docs.gravatar.com/guides/llms-txt

Installs the Gravatar Hovercards library using npm for advanced integration. This is the first step to enable hovercard functionality on your site.

```javascript
npm install @gravatar-com/hovercards
```

--------------------------------

### Fetch User Profile Data with Authentication

Source: https://docs.gravatar.com/rest/authentication

An example showing how to construct a profile URL using a Gravatar hash and fetch the user's profile data using an authenticated GET request.

```javascript
const hash = getGravatarHash('user@example.com'); // Assuming getGravatarHash is defined elsewhere
const profileUrl = `https://api.gravatar.com/v3/profiles/${hash}`;

// With authentication (recommended)
fetch(profileUrl, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
})
.then(response => response.json())
.then(profile => console.log(profile));
```

--------------------------------

### Gravatar REST API Reference

Source: https://docs.gravatar.com/avatars/ruby

This section outlines the core components and references for the Gravatar REST API. It covers essential aspects like getting started, authentication methods, the process of creating a Gravatar identifier (hash), and detailed API data specifications including endpoints and data models.

```APIDOC
Gravatar REST API:

Overview:
  - Getting started: https://docs.gravatar.com/rest/getting-started/
  - Authentication: https://docs.gravatar.com/rest/authentication/
  - Creating identifier (hash): https://docs.gravatar.com/rest/hash/

API Data Specifications:
  - Endpoints references: https://docs.gravatar.com/rest/api-data-specifications/endpoints-references/
  - Data models: https://docs.gravatar.com/rest/api-data-specifications/data-models/

API Explorer:
  - Console access: https://gravatar.com/developers/console

Components:
  - Avatars: https://docs.gravatar.com/sdk/images/
  - Profiles: https://docs.gravatar.com/sdk/profiles/
  - Gravatar quick editor: https://docs.gravatar.com/sdk/quickeditor/
  - Hovercards: https://docs.gravatar.com/sdk/hovercards/
  - QR codes: https://docs.gravatar.com/sdk/qr-codes/

Mobile SDKs:
  - Android SDK: https://docs.gravatar.com/mobile-sdk/android-sdk/
  - iOS SDK: https://docs.gravatar.com/mobile-sdk/ios-sdk/

Guides:
  - User profile tutorial (React): https://docs.gravatar.com/guides/tutorial-user-profile/
  - Gravatar for live events: https://docs.gravatar.com/guides/qr-code-badges/
  - Example integrations: https://docs.gravatar.com/guides/integrations/
  - Use with AI assistants: https://docs.gravatar.com/guides/llms-txt/

```

--------------------------------

### Gravatar Integration Guides for AI

Source: https://docs.gravatar.com/guides/llms-txt

Specific guidance for integrating Gravatar with AI assistants and development environments. This section provides directions optimized for AI parsing to ensure accurate implementation guidance.

```APIDOC
Use with AI assistants:
This documentation is optimized for AI parsing to provide accurate guidance when implementing Gravatar integration.

For AI Development Environments:
Gravatar API Documentation v3.0.0 – LLMS.TXT
This documentation serves as a comprehensive reference template designed for integration with AI coding assistants such as Cursor, Windsurf, Bolt, v0, Lovable, Claude, OpenAI, Gemini, and similar tools.

Key Sections for AI Integration:
1. Introduction
2. Key Benefits
3. API Capabilities
4. Quick Start
5. Authentication
6. Core Concepts
7. Endpoints Reference
8. Data Formats
9. Data Models
10. SDK Integration
11. Components
12. Error Handling & Troubleshooting
13. Reference
```

--------------------------------

### Gravatar REST API Reference

Source: https://docs.gravatar.com/avatars/python

Documentation for the Gravatar REST API. Covers essential aspects like getting started, authentication mechanisms, the process of creating an identifier hash from an email address, and detailed specifications for API endpoints and data models.

```APIDOC
Gravatar REST API:
  - Getting started: Information on initial setup and usage.
  - Authentication: Details on how to authenticate API requests.
  - Creating identifier (hash):
    - Process: Hash the user's email address using SHA256 after converting it to lowercase.
    - Example (conceptual):
      email = "user@example.com"
      hashed_email = sha256(email.lower().encode('utf-8')).hexdigest()
      // Resulting hash is used in the avatar URL.
  - API data specifications:
    - Endpoints references: Documentation for available API endpoints.
    - Data models: Definitions of data structures used by the API.
```

--------------------------------

### AI Instructions for Gravatar Integration

Source: https://docs.gravatar.com/2025/06/30/we-built-3-apps-in-a-day-using-ai-gravatar-you-can-too

This conceptual snippet represents the AI instructions provided to an AI assistant to understand Gravatar's functionality and integrate it into applications. It guides the AI on how Gravatar data can enhance user experience, such as populating profiles instantly.

```AI
You are an AI assistant tasked with building applications that integrate with Gravatar.
Gravatar provides users with a globally recognized avatar and profile information based on their email address.
When a user signs up or logs in with an email, Gravatar can automatically supply their avatar, bio, interests, and location (if shared).
This significantly reduces profile setup fatigue and creates more vibrant communities by pre-populating user data.
Focus on using Gravatar data to personalize user experiences and streamline onboarding processes.
Be aware that while older systems might suggest MD5 hashing for email addresses, Gravatar currently supports and encourages SHA256 hashing for better security and functionality.
Your goal is to build applications that leverage Gravatar to solve problems like event RSVP management, attendee discovery, and personalized event recommendations.
```

--------------------------------

### Gravatar REST API Overview

Source: https://docs.gravatar.com/mobile-sdk

The Gravatar REST API provides endpoints for developers to integrate Gravatar functionality into their applications. Key areas include getting started, authentication methods, creating user identifiers (hashes), and detailed API data specifications covering endpoints and data models. An API Explorer is also available for testing.

```APIDOC
Gravatar REST API:

Key Resources:
  - Getting Started: Guides for initial setup and integration.
  - Authentication: Information on how to authenticate API requests.
  - Creating Identifier (Hash): Details on generating the MD5 hash of an email address required for Gravatar URLs.
    - Method: MD5 hashing of lowercase email address.
    - Example: `md5(strtolower(email))`
  - API Data Specifications:
    - Endpoints References: Documentation for available API endpoints.
    - Data Models: Definitions of data structures returned by the API.
  - API Explorer (Console): An interactive tool to test Gravatar API endpoints.
```

--------------------------------

### Test Backend Endpoint

Source: https://docs.gravatar.com/api/profiles/tutorial-user-profile

Example URL to test the backend endpoint by providing an email address associated with a Gravatar account.

```http
http://localhost:3000/api/profile/sarahthompson@fork.do
```

--------------------------------

### Gravatar REST API Reference

Source: https://docs.gravatar.com/avatars/go

Documentation for the Gravatar REST API, covering essential aspects like getting started, authentication, creating unique identifiers (hashes) from email addresses, and detailed API data specifications including endpoints and data models. This API is key for integrating Gravatar avatars and profile information into applications.

```APIDOC
Gravatar REST API:

Overview:
  Provides programmatic access to Gravatar avatars and profile data.

Key Sections:
  - Getting started: https://docs.gravatar.com/rest/getting-started/
  - Authentication: https://docs.gravatar.com/rest/authentication/
  - Creating identifier (hash): https://docs.gravatar.com/rest/hash/
    - Process: Hash an email address using SHA256, then hex-encode the result.
    - Example (conceptual): sha256(strtolower(trim(email_address)))
  - API data specifications: https://docs.gravatar.com/rest/api-data-specifications/
    - Endpoints references: https://docs.gravatar.com/rest/api-data-specifications/endpoints-references/
    - Data models: https://docs.gravatar.com/rest/api-data-specifications/data-models/

Related Components:
  - Avatars: https://docs.gravatar.com/sdk/images/
  - Profiles: https://docs.gravatar.com/sdk/profiles/
  - Hovercards: https://docs.gravatar.com/sdk/hovercards/
  - QR codes: https://docs.gravatar.com/sdk/qr-codes/

API Explorer:
  - Console access: https://gravatar.com/developers/console
```

--------------------------------

### Test Backend Endpoint

Source: https://docs.gravatar.com/guides/tutorial-user-profile

Example URL to test the backend endpoint by providing an email address associated with a Gravatar account.

```http
http://localhost:3000/api/profile/sarahthompson@fork.do
```

--------------------------------

### Go Gravatar Implementation

Source: https://docs.gravatar.com/avatars/go

An example implementation in Go for generating Gravatar image URLs from an email address. It handles hashing the email, constructing the URL with optional parameters like size, rating, and default image, and uses standard Go libraries for crypto and URL manipulation.

```go
package gravatar

import (
	"crypto/sha256"
	"encoding/hex"
	"net/url"
	"strconv"
	"strings"
)

const (
	defaultScheme   = "https"
	defaultHostname = "www.gravatar.com"
)

func NewGravatarFromEmail(email string) Gravatar {
	hasher := sha256.Sum256([]byte(strings.TrimSpace(email)))
	hash := hex.EncodeToString(hasher[:])

	g := NewGravatar()
	g.Hash = hash
	return g
}

func NewGravatar() Gravatar {
	return Gravatar{
		Scheme: defaultScheme,
		Host:   defaultHostname,
	}
}

type Gravatar struct {
	Scheme  string
	Host    string
	Hash    string
	Default string
	Rating  string
	Size    int
}

func (g Gravatar) GetURL() string {
	path := "/avatar/" + g.Hash

	v := url.Values{}
	if g.Size > 0 {
		v.Add("s", strconv.Itoa(g.Size))
	}

	if g.Rating != ""
	{
		v.Add("r", g.Rating)
	}

	if g.Default != ""
	{
		v.Add("d", g.Default)
	}

	url := url.URL{
		Scheme:   g.Scheme,
		Host:     g.Host,
		Path:     path,
		RawQuery: v.Encode(),
	}

	return url.String()
}

```

--------------------------------

### Gravatar User Profile Integration (React/NodeJS)

Source: https://docs.gravatar.com/api/profiles/tutorial-user-profile

Guides developers on implementing a user profile card using Gravatar's API within a React/NodeJS application. It covers setting up a development environment, integrating the Gravatar API for backend endpoints, and creating frontend components like GravatarCard and a search component.

```javascript
// Step 1: Setup a dev environment and your Gravatar API Key
// (Details on obtaining API key and environment setup are in the full guide)

// Step 2: Hook up the Gravatar API - Setting up the backend endpoint
// (This involves making API calls to Gravatar to fetch user data)

// Step 3: Design Your Profile Page - Creating the GravatarCard Component
// Example structure for a React component:
/*
function GravatarCard({ userProfile }) {
  return (
    <div>
      <img src={userProfile.avatarUrl} alt="User Avatar" />
      <h2>{userProfile.displayName}</h2>
      <p>{userProfile.aboutMe}</p>
      <a href={userProfile.profileUrl}>View Profile</a>
    </div>
  );
}
*/

// Step 4: Creating a Gravatar Search Component
// (Allows users to search for Gravatar profiles)

// Step 5: Creating a skeleton loading effect
// (For improved user experience during data fetching)

// Step 6: Adding a link and some legalese
// (Standard practice for attribution or terms)

// Step 7: That’s it
// (Completion of the basic integration)
```

--------------------------------

### Gravatar User Profile Integration (React/NodeJS)

Source: https://docs.gravatar.com/guides/tutorial-user-profile

Guides developers on implementing a user profile card using Gravatar's API within a React/NodeJS application. It covers setting up a development environment, integrating the Gravatar API for backend endpoints, and creating frontend components like GravatarCard and a search component.

```javascript
// Step 1: Setup a dev environment and your Gravatar API Key
// (Details on obtaining API key and environment setup are in the full guide)

// Step 2: Hook up the Gravatar API - Setting up the backend endpoint
// (This involves making API calls to Gravatar to fetch user data)

// Step 3: Design Your Profile Page - Creating the GravatarCard Component
// Example structure for a React component:
/*
function GravatarCard({ userProfile }) {
  return (
    <div>
      <img src={userProfile.avatarUrl} alt="User Avatar" />
      <h2>{userProfile.displayName}</h2>
      <p>{userProfile.aboutMe}</p>
      <a href={userProfile.profileUrl}>View Profile</a>
    </div>
  );
}
*/

// Step 4: Creating a Gravatar Search Component
// (Allows users to search for Gravatar profiles)

// Step 5: Creating a skeleton loading effect
// (For improved user experience during data fetching)

// Step 6: Adding a link and some legalese
// (Standard practice for attribution or terms)

// Step 7: That’s it
// (Completion of the basic integration)
```

--------------------------------

### Gravatar Foreign Data Wrapper

Source: https://docs.gravatar.com/guides/llms-txt

Information on using the Gravatar Foreign Data Wrapper, particularly for PostgreSQL setups like Supabase. It provides a link to the GitHub repository for the wrapper.

```APIDOC
Foreign Data Wrapper for Gravatar:
If you are working with Supabase, a PostgreSQL setup, take a look at our Foreign Data Wrapper.

Repository: https://github.com/Automattic/gravatar-wasm-fdw
```

--------------------------------

### Gravatar Android SDK Initialization

Source: https://docs.gravatar.com/guides/llms-txt

Configure the Android build to include the Gravatar API key and initialize the Gravatar SDK in your application. The API key should be stored securely, for example, in local.properties.

```Kotlin
// Store API key in local.properties
// gravatar.api.key = YOUR_API_KEY

// Add to build.gradle (module level)
android {
    buildFeatures.buildConfig = true
    val properties = Properties()
    properties.load(FileInputStream(project.rootProject.file("local.properties")))
    buildConfigField("String", "GRAVATAR_API_KEY", "\"${properties["gravatar.api.key"]}\"")
}

// Initialize in your app (e.g., Application class)
Gravatar.initialize(BuildConfig.GRAVATAR_API_KEY)
```

--------------------------------

### Gravatar REST API Overview

Source: https://docs.gravatar.com/api

This section outlines the key areas of the Gravatar REST API documentation. It includes links to specific guides for developers, covering authentication, hash creation, and data specifications, as well as references to API data models and endpoints.

```APIDOC
Gravatar REST API:
  - Getting started: https://docs.gravatar.com/rest/getting-started/
  - Authentication: https://docs.gravatar.com/rest/authentication/
  - Creating identifier (hash): https://docs.gravatar.com/rest/hash/
  - API data specifications: https://docs.gravatar.com/rest/api-data-specifications/
    + Endpoints references: https://docs.gravatar.com/rest/api-data-specifications/endpoints-references/
    + Data models: https://docs.gravatar.com/rest/api-data-specifications/data-models/
  - API Explorer (console): https://gravatar.com/developers/console
```

--------------------------------

### Fetch User AI Profile with JavaScript

Source: https://docs.gravatar.com/2025/05/29/user-identity-shouldnt-be-left-behind

Example of how to fetch a user's AI profile data using the Gravatar API endpoint in a JavaScript application. This demonstrates a common use case for integrating user context into AI-driven features.

```javascript
// Get user's AI profile
const emailHash = "a0e3c61b1234567890abcdef12345678"; // Replace with actual email hash

async function getUserProfile(hash) {
  try {
    const response = await fetch(`https://gravatar.com/${hash}.md`);
    if (!response.ok) {
      throw new Error(`HTTP error! status: ${response.status}`);
    }
    const profileText = await response.text();
    // Your AI now knows their basic info, preferences, background
    console.log("User Profile Data:", profileText);
    return profileText;
  } catch (error) {
    console.error("Failed to fetch user profile:", error);
    return null;
  }
}

getUserProfile(emailHash);
```

--------------------------------

### Fetch Gravatar Profile Data (JavaScript)

Source: https://docs.gravatar.com/rest/getting-started

Fetches rich Gravatar profile data for a user by making an authenticated GET request to the Gravatar API. Requires an API key for authentication.

```javascript
const hash = getGravatarHash('user@example.com');
const profileUrl = `https://api.gravatar.com/v3/profiles/${hash}`;

// With authentication (recommended)
fetch(profileUrl, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
})
.then(response => response.json())
.then(profile => console.log(profile));

```

--------------------------------

### Install Gravatar iOS SDK using Swift Package Manager

Source: https://docs.gravatar.com/mobile-sdk/ios-sdk

This snippet shows how to add the Gravatar iOS SDK to your Xcode project using Swift Package Manager. It involves specifying the repository URL and selecting the Gravatar product for your target.

```Swift
let package = Package(
    name: "Package Name",
    dependencies: [
        // 1.
        .package(url: "https://github.com/Automattic/Gravatar-SDK-iOS.git", from: "x.y.z")
    ],
    targets: [
        .executableTarget(
            name: "Target Name",
            dependencies: [
                // 2.
                .product(name: "Gravatar", package: "Gravatar")
            ]
        )
    ]
)
```

--------------------------------

### Fetch Gravatar Profile Data (JavaScript)

Source: https://docs.gravatar.com/getting-started

Fetches rich Gravatar profile data for a user by making an authenticated GET request to the Gravatar API. Requires an API key for authentication.

```javascript
const hash = getGravatarHash('user@example.com');
const profileUrl = `https://api.gravatar.com/v3/profiles/${hash}`;

// With authentication (recommended)
fetch(profileUrl, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
})
.then(response => response.json())
.then(profile => console.log(profile));

```

--------------------------------

### Install Gravatar iOS SDK using CocoaPods

Source: https://docs.gravatar.com/mobile-sdk/ios-sdk

This snippet demonstrates how to integrate the Gravatar iOS SDK into your iOS project using CocoaPods. It requires adding the 'Gravatar' pod to your Podfile and specifying necessary configurations.

```Ruby
source 'https://github.com/CocoaPods/Specs.git'
use_frameworks!

target 'MyApp' do
    pod 'Gravatar'
end
```

--------------------------------

### Node.js Gravatar Profile API Endpoint

Source: https://docs.gravatar.com/api/profiles/tutorial-user-profile

Sets up a backend route to fetch Gravatar profile data. It hashes the email using SHA-256, makes an authenticated GET request to the Gravatar API, and returns the profile data or an error.

```javascript
app.get( '/api/profile/:identifier', async ( req, res ) => {
    const { identifier } = req.params;

    try {
        const hash = crypto.createHash( 'sha256' ).update( identifier.trim().toLowerCase() ).digest( 'hex' );

        const response = await axios.get( `https://api.gravatar.com/v3/profiles/${ hash }`, {
            headers: {
                Authorization: `Bearer ${ process.env.API_KEY }`,
            },
        } );

        res.json( response.data );
    } catch ( error ) {
        res.status( error.response ? error.response.status : 500 ).json( {
            error: error.message
        } );
    }
} );
```

--------------------------------

### Get Inferred Interests (Curl Example)

Source: https://docs.gravatar.com/rest/api-data-specifications/endpoints-references

Example using curl to fetch inferred interests for a Gravatar profile, including authentication.

```bash
curl -X GET "https://api.gravatar.com/v3/profiles/84059b07d4be67b806386c0aad8070a23f18836bbaae342275dc0a83414c32ee/inferred-interests" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### Get Inferred Interests Response (JSON)

Source: https://docs.gravatar.com/rest/api-data-specifications/endpoints-references

Example JSON response for inferred interests associated with a Gravatar profile, listing interests with IDs and slugs.

```json
[
  {
    "id": 81,
    "slug": "81-coding",
    "name": "coding"
  },
  {
    "id": 191,
    "slug": "191-internet-of-things",
    "name": "internet of things"
  },
  {
    "id": 240,
    "slug": "240-online-education",
    "name": "online education"
  },
  {
    "id": 267,
    "slug": "267-programming-languages",
    "name": "programming languages"
  },
  {
    "id": 398,
    "slug": "398-wordpress",
    "name": "wordpress"
  }
]
```

--------------------------------

### Development Server Commands

Source: https://docs.gravatar.com/api/profiles/tutorial-user-profile

Commands required to build client files, watch for changes, and run the development server for the project.

```bash
npm run dev
npm start
```

--------------------------------

### Initialize and Use Gravatar Quick Editor

Source: https://docs.gravatar.com/guides/quickeditor

This JavaScript snippet demonstrates initializing the GravatarQuickEditorCore with user details and event handlers. It also shows how to trigger the editor's open method when a specific DOM element is clicked. Requires the '@gravatar-com/quick-editor' package.

```javascript
import { GravatarQuickEditorCore } from '@gravatar-com/quick-editor';

document.addEventListener( 'DOMContentLoaded', () => {
  const quickEditorCore = new GravatarQuickEditorCore( {
    email: 'user@example.com',
    scope: [ 'avatars', 'about' ],
    onProfileUpdated: () => {
      console.log( 'Profile updated!' );
    },
    onOpened: () => {
      console.log( 'Editor opened!' );
    },
  } );

  document.getElementById( 'edit-profile' ).addEventListener( 'click', () => {
    quickEditorCore.open();
  } );
} );
```

--------------------------------

### Get Gravatar Profile Response (JSON)

Source: https://docs.gravatar.com/rest/api-data-specifications/endpoints-references

Example JSON response when successfully retrieving a Gravatar profile, detailing user information like display name, location, and avatar URL.

```json
{
  "hash": "84059b07d4be67b806386c0aad8070a23f18836bbaae342275dc0a83414c32ee",
  "profile_url": "https://gravatar.com/example",
  "avatar_url": "https://0.gravatar.com/avatar/84059b07d4be67b806386c0aad8070a23f18836bbaae342275dc0a83414c32ee",
  "avatar_alt_text": "User's avatar",
  "display_name": "John Smith",
  "pronouns": "He/Him",
  "location": "San Francisco, CA",
  "job_title": "Software Engineer",
  "company": "Tech Company",
  "description": "About me section text",
  "verified_accounts": [
    {
      "service_type": "twitter",
      "service_label": "Twitter",
      "service_icon": "https://example.com/icon.png",
      "url": "https://twitter.com/username",
      "is_hidden": false
    }
  ]
}
```

--------------------------------

### Initialize and Use Gravatar Quick Editor

Source: https://docs.gravatar.com/sdk/quickeditor

This JavaScript snippet demonstrates initializing the GravatarQuickEditorCore with user details and event handlers. It also shows how to trigger the editor's open method when a specific DOM element is clicked. Requires the '@gravatar-com/quick-editor' package.

```javascript
import { GravatarQuickEditorCore } from '@gravatar-com/quick-editor';

document.addEventListener( 'DOMContentLoaded', () => {
  const quickEditorCore = new GravatarQuickEditorCore( {
    email: 'user@example.com',
    scope: [ 'avatars', 'about' ],
    onProfileUpdated: () => {
      console.log( 'Profile updated!' );
    },
    onOpened: () => {
      console.log( 'Editor opened!' );
    },
  } );

  document.getElementById( 'edit-profile' ).addEventListener( 'click', () => {
    quickEditorCore.open();
  } );
} );
```

--------------------------------

### Authenticated API Request Example

Source: https://docs.gravatar.com/rest/authentication

Demonstrates how to make an authenticated GET request to the Gravatar API using JavaScript's Fetch API, including setting the Authorization header with a Bearer token.

```javascript
fetch('https://api.gravatar.com/v3/profiles/example', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
})
.then(response => response.json())
.then(data => console.log(data));
```

--------------------------------

### Development Server Commands

Source: https://docs.gravatar.com/guides/tutorial-user-profile

Commands required to build client files, watch for changes, and run the development server for the project.

```bash
npm run dev
npm start
```

--------------------------------

### Gravatar REST API

Source: https://docs.gravatar.com/index

Documentation for the Gravatar REST API, covering getting started, authentication, identifier creation, and data specifications. It allows retrieval of user profile information such as avatars, display names, location, and biographies based on an email address.

```APIDOC
Gravatar REST API Documentation:

Purpose:
  The Gravatar API provides access to rich user profile data associated with email addresses. This enables applications to display user avatars, names, biographies, interests, and other profile details.

Key Features:
  - Avatars: Global user avatars.
  - Display Names: User's chosen display name.
  - Location: User's geographical location.
  - Verified Accounts: Links to verified social media profiles.
  - Biography: User's personal description.
  - Interests: User-specified interests.
  - Job Title & Company: Professional information.
  - Contact Info: Email, phone, website.
  - Photos: Additional user-uploaded photos.
  - Languages: User's spoken languages.
  - Payments: Information related to payment profiles.

Core Concepts:
  - Email Hashing: User profiles are accessed by hashing the user's email address (e.g., MD5 hash of the lowercase email).

API Access Points:
  - Getting Started: https://docs.gravatar.com/rest/getting-started/
  - Authentication: https://docs.gravatar.com/rest/authentication/
  - Creating Identifier (Hash): https://docs.gravatar.com/rest/hash/ - Explains how to generate the necessary email hash.
  - API Data Specifications: https://docs.gravatar.com/rest/api-data-specifications/ - Details the structure and types of data available.
    - Endpoints References: https://docs.gravatar.com/rest/api-data-specifications/endpoints-references/
    - Data Models: https://docs.gravatar.com/rest/api-data-specifications/data-models/

Tools:
  - OpenAPI Specification: https://api.gravatar.com/v3/openapi - Formal definition of the API.
  - API Explorer: https://gravatar.com/developers/console - Interactive console for testing API calls.

Usage:
  Applications typically construct a URL using the hashed email address to retrieve profile data, often in JSON format.
```

--------------------------------

### Gravatar API Reference

Source: https://docs.gravatar.com/rest/getting-started

Documentation for Gravatar's v3 REST API, including base URL, authentication methods, and endpoints for profile data.

```APIDOC
Base URL:
  https://api.gravatar.com/v3

Authentication:
  Gravatar uses Bearer Tokens. Include your API key in the Authorization header.
  Example: Authorization: Bearer YOUR_API_KEY

Endpoints:
  - Get Profile Data:
    Method: GET
    Path: /profiles/{email_hash}
    Description: Fetches detailed profile information for a given email hash.
    Parameters:
      - email_hash (path parameter, string, required): The SHA256 hash of the user's email address.
    Returns:
      JSON object containing profile data (display name, about me, photos, etc.).
    Example Request:
      GET https://api.gravatar.com/v3/profiles/84059b07d4be67b806386c0aad8070a23f18836bbaae342275dc0a83414c32ee
      Headers:
        Authorization: Bearer YOUR_API_KEY

  - Avatar URL Construction:
    URL Format: https://0.gravatar.com/avatar/{email_hash}
    Description: URL to retrieve a user's avatar image. The email_hash is the SHA256 hash of the user's email address.
    Example:
      https://0.gravatar.com/avatar/84059b07d4be67b806386c0aad8070a23f18836bbaae342275dc0a83414c32ee

Related Information:
  - API Key Generation: Navigate to the Gravatar Developer Dashboard and create a new application.
  - Email Hashing: Ensure email is trimmed and lowercased before SHA256 hashing.
  - SDKs: Gravatar provides SDKs for iOS and Android for easier integration.
```

--------------------------------

### Gravatar API Reference

Source: https://docs.gravatar.com/getting-started

Documentation for Gravatar's v3 REST API, including base URL, authentication methods, and endpoints for profile data.

```APIDOC
Base URL:
  https://api.gravatar.com/v3

Authentication:
  Gravatar uses Bearer Tokens. Include your API key in the Authorization header.
  Example: Authorization: Bearer YOUR_API_KEY

Endpoints:
  - Get Profile Data:
    Method: GET
    Path: /profiles/{email_hash}
    Description: Fetches detailed profile information for a given email hash.
    Parameters:
      - email_hash (path parameter, string, required): The SHA256 hash of the user's email address.
    Returns:
      JSON object containing profile data (display name, about me, photos, etc.).
    Example Request:
      GET https://api.gravatar.com/v3/profiles/84059b07d4be67b806386c0aad8070a23f18836bbaae342275dc0a83414c32ee
      Headers:
        Authorization: Bearer YOUR_API_KEY

  - Avatar URL Construction:
    URL Format: https://0.gravatar.com/avatar/{email_hash}
    Description: URL to retrieve a user's avatar image. The email_hash is the SHA256 hash of the user's email address.
    Example:
      https://0.gravatar.com/avatar/84059b07d4be67b806386c0aad8070a23f18836bbaae342275dc0a83414c32ee

Related Information:
  - API Key Generation: Navigate to the Gravatar Developer Dashboard and create a new application.
  - Email Hashing: Ensure email is trimmed and lowercased before SHA256 hashing.
  - SDKs: Gravatar provides SDKs for iOS and Android for easier integration.
```

--------------------------------

### Install Crypto Dependency for Node.js

Source: https://docs.gravatar.com/avatars/node

Installs the necessary `crypto` library using npm for SHA-256 hashing in Node.js applications. This is a prerequisite for generating Gravatar hashes.

```bash
npm install crypto
```

--------------------------------

### Hashing Algorithm Best Practices

Source: https://docs.gravatar.com/2025/06/30/we-built-3-apps-in-a-day-using-ai-gravatar-you-can-too

This snippet highlights a key learning point regarding hashing algorithms for Gravatar integration. It contrasts older recommendations (MD5) with current best practices (SHA256), emphasizing the importance of using up-to-date information for AI training data.

```General
When integrating with Gravatar, be mindful of hashing algorithms.
Older AI training data might recommend MD5 hashing for email addresses.
However, Gravatar currently supports and encourages the use of SHA256 hashing for email addresses.
Ensure your AI prompts and application logic reflect the most current recommendations for optimal results and security.
```

--------------------------------

### Gravatar Image Rating Example

Source: https://docs.gravatar.com/sdk/images

Demonstrates how to request Gravatar images up to a specific rating level using the 'r=' parameter. This example requests images rated 'pg' (parental guidance).

```url
https://gravatar.com/avatar/27205e5c51cb03f862138b22bcb5dc20f94a342e744ff6df1b8dc8af3c865109?r=pg
```

--------------------------------

### Gravatar Image Rating Example

Source: https://docs.gravatar.com/general/images

Demonstrates how to request Gravatar images up to a specific rating level using the 'r=' parameter. This example requests images rated 'pg' (parental guidance).

```url
https://gravatar.com/avatar/27205e5c51cb03f862138b22bcb5dc20f94a342e744ff6df1b8dc8af3c865109?r=pg
```

--------------------------------

### Integrate Gravatar Skeleton in Component

Source: https://docs.gravatar.com/api/profiles/tutorial-user-profile

Demonstrates how to replace a simple 'Loading...' text with the custom `GravatarSkeleton` component when the `isLoading` state is true. It also shows the necessary import statement for the skeleton component and its styles.

```jsx
import React from 'react';
import GravatarSkeleton from './skeleton';
import './style.scss'

// ... inside your component render method ...

if ( isLoading ) {
    return <GravatarSkeleton />
}
```
Tokens:
Raw