Type-safe AT Protocol HTTP client with OAuth 2.0 support for Laravel.

What is AtpClient?#

AtpClient is a Laravel package for interacting with Bluesky and the AT Protocol. It provides a fluent, type-safe API for authentication, posting, profiles, follows, likes, and feeds. Supports both OAuth 2.0 (with PKCE, PAR, and DPoP) and app passwords.

Think of it as Laravel's HTTP client, but for the decentralized social web.

Why use AtpClient?#

• Laravel-style code - Familiar patterns you already know
• OAuth 2.0 support - Full PKCE, PAR, and DPoP implementation
• App password support - Simple authentication for scripts and bots
• Automatic token refresh - Sessions stay alive without manual intervention
• Type-safe API - Method chaining with IDE autocompletion
• Rich text builder - Fluent API for mentions, links, and hashtags
• Full Bluesky coverage - Posts, profiles, follows, likes, and feeds
• AT Protocol operations - Low-level repository access when needed

Quick Example#

use SocialDept\AtpClient\Facades\Atp;

// Login with app password
$client = Atp::login('yourhandle.bsky.social', 'your-app-password');

// Create a post
$post = $client->bsky->post->create('Hello from Laravel!');

// Get your timeline
$timeline = $client->bsky->feed->getTimeline(limit: 50);

Installation#

composer require socialdept/atp-client

Optionally publish the configuration:

php artisan vendor:publish --tag=atp-client-config

Getting Started#

Once installed, you're three steps away from using the AT Protocol:

1. Choose Your Authentication Method#

App Password (recommended for bots/scripts):

$client = Atp::login('yourhandle.bsky.social', 'your-app-password');

OAuth 2.0 (recommended for user-facing apps):

$auth = Atp::oauth()->authorize('user@bsky.social');
return redirect($auth->url);

2. Make API Calls#

// Create posts
$client->bsky->post->create('Hello world!');

// Get profiles
$client->bsky->actor->getProfile('someone.bsky.social');

// Browse feeds
$client->bsky->feed->getTimeline();

3. Store Credentials (OAuth only)#

Implement the CredentialProvider interface to persist tokens between requests.

What can you build?#

• Bluesky integrations - Connect your app to the AT Protocol
• Social media management - Post and manage content programmatically
• Automated posting - Schedule and automate content delivery
• Analytics dashboards - Track engagement and activity
• Moderation tools - Build bots for community moderation
• Cross-platform syndication - Mirror content across networks

Authentication#

App Password Flow#

The simplest way to authenticate. Generate an app password in your Bluesky settings.

use SocialDept\AtpClient\Facades\Atp;

$client = Atp::login('yourhandle.bsky.social', 'your-app-password');

// Client is now authenticated and ready to use
$profile = $client->bsky->actor->getProfile('yourhandle.bsky.social');

OAuth 2.0 Flow#

For user-facing applications where users authenticate with their own accounts.

Step 1: Initiate authorization

use SocialDept\AtpClient\Facades\Atp;

public function redirect()
{
    $auth = Atp::oauth()->authorize('user@bsky.social');

    // Store auth request in session for callback
    session(['atp_auth' => $auth]);

    return redirect($auth->url);
}

Step 2: Handle callback

public function callback(Request $request)
{
    $auth = session('atp_auth');

    $token = Atp::oauth()->callback(
        code: $request->get('code'),
        state: $request->get('state'),
        request: $auth
    );

    // Store credentials using your CredentialProvider
    // $token contains: accessJwt, refreshJwt, did, handle, expiresAt
}

Step 3: Use stored credentials

// After storing credentials, use them with Atp::as()
$client = Atp::as('user@bsky.social');

Token Refresh#

Sessions automatically refresh when tokens are about to expire (default: 5 minutes before expiration). Listen to events if you need to persist refreshed tokens:

use SocialDept\AtpClient\Events\TokenRefreshed;

Event::listen(TokenRefreshed::class, function ($event) {
    // $event->session - the Session being refreshed
    // $event->token - the new AccessToken
    // Update your credential storage here

    // Check auth type if needed
    if ($event->session->isLegacy()) {
        // App password session
    }
});

Working with Posts#

Create a Simple Post#

$post = $client->bsky->post->create('Hello, Bluesky!');

// Returns StrongRef with uri and cid
echo $post->uri;  // at://did:plc:.../app.bsky.feed.post/...
echo $post->cid;  // bafyre...

Rich Text with Mentions, Links, and Hashtags#

Use the TextBuilder for posts with rich text formatting:

use SocialDept\AtpClient\RichText\TextBuilder;

$content = TextBuilder::make()
    ->text('Check out ')
    ->mention('someone.bsky.social')
    ->text(' and visit ')
    ->link('our website', 'https://example.com')
    ->text(' ')
    ->tag('Laravel')
    ->toArray();

$post = $client->bsky->post->create($content);

Or use auto-detection on plain text:

// Facets are automatically detected
$post = $client->bsky->post->create(
    'Hello @someone.bsky.social! Check out https://example.com #Bluesky'
);

Reply to a Post#

$parent = new StrongRef(uri: 'at://...', cid: 'bafyre...');
$root = $parent; // Same as parent for direct replies

$reply = $client->bsky->post->reply(
    parent: $parent,
    root: $root,
    content: 'This is a reply!'
);

Quote Post#

$quotedPost = new StrongRef(uri: 'at://...', cid: 'bafyre...');

$quote = $client->bsky->post->quote(
    quotedPost: $quotedPost,
    content: 'Interesting take!'
);

Post with Images#

// Upload from a Laravel request
$blob = $client->atproto->repo->uploadBlob($request->file('image'));

// Or from a file path
$blob = $client->atproto->repo->uploadBlob(new SplFileInfo('/path/to/image.jpg'));

// Or from raw binary data (mimeType required)
$blob = $client->atproto->repo->uploadBlob(
    file: file_get_contents('/path/to/image.jpg'),
    mimeType: 'image/jpeg'
);

$post = $client->bsky->post->withImages(
    content: 'Check out this photo!',
    images: [
        [
            'image' => $blob->json('blob'),
            'alt' => 'Description of the image',
        ],
    ]
);

Post with External Link Card#

$post = $client->bsky->post->withLink(
    content: 'Great article about Laravel',
    uri: 'https://example.com/article',
    title: 'Article Title',
    description: 'A brief description of the article...'
);

Delete a Post#

// Extract rkey from the post URI
$rkey = basename($post->uri);

$client->bsky->post->delete($rkey);

Working with Profiles#

Get a Profile#

$profile = $client->bsky->actor->getProfile('someone.bsky.social');

echo $profile->json('displayName');
echo $profile->json('description');
echo $profile->json('followersCount');

Update Your Profile#

// Update display name
$client->bsky->profile->updateDisplayName('New Name');

// Update bio/description
$client->bsky->profile->updateDescription('Laravel developer building on AT Protocol');

// Update multiple fields at once
$client->bsky->profile->update([
    'displayName' => 'New Name',
    'description' => 'New bio here',
]);

Update Avatar#

$blob = $client->atproto->repo->uploadBlob(new SplFileInfo('/path/to/avatar.jpg'));

$client->bsky->profile->updateAvatar($blob->json('blob'));

Social Graph#

Follow a User#

// Follow requires the user's DID
$follow = $client->bsky->follow->create('did:plc:...');

Unfollow a User#

// Get the rkey from the follow record URI
$client->bsky->follow->delete($rkey);

Like a Post#

$postRef = new StrongRef(uri: 'at://...', cid: 'bafyre...');

$like = $client->bsky->like->create($postRef);

Unlike a Post#

$client->bsky->like->delete($rkey);

Feed Operations#

Get Your Timeline#

$timeline = $client->bsky->feed->getTimeline(limit: 50);

foreach ($timeline->json('feed') as $item) {
    $post = $item['post'];
    echo $post['author']['handle'] . ': ' . $post['record']['text'];
}

Pagination with Cursors#

$cursor = null;

do {
    $timeline = $client->bsky->feed->getTimeline(limit: 100, cursor: $cursor);

    foreach ($timeline->json('feed') as $item) {
        // Process posts
    }

    $cursor = $timeline->json('cursor');
} while ($cursor);

Get Author Feed#

$feed = $client->bsky->feed->getAuthorFeed(
    actor: 'someone.bsky.social',
    limit: 50
);

Search Posts#

$results = $client->bsky->feed->searchPosts(
    q: 'laravel php',
    limit: 25
);

Get Post Thread#

$thread = $client->bsky->feed->getPostThread(
    uri: 'at://did:plc:.../app.bsky.feed.post/...',
    depth: 6
);

Get Likes on a Post#

$likes = $client->bsky->feed->getLikes(uri: 'at://...');

Get Reposts#

$reposts = $client->bsky->feed->getRepostedBy(uri: 'at://...');

Configuration#

After publishing the config file, you can customize these options:

// config/client.php

return [
    // OAuth client metadata
    'client' => [
        'name' => env('ATP_CLIENT_NAME', config('app.name')),
        'url' => env('ATP_CLIENT_URL', config('app.url')),
        'redirect_uris' => [
            env('ATP_CLIENT_REDIRECT_URI', config('app.url').'/auth/atp/callback'),
        ],
        'scopes' => ['atproto', 'transition:generic'],
    ],

    // Credential storage provider
    'credential_provider' => \SocialDept\AtpClient\Providers\ArrayCredentialProvider::class,

    // Session behavior
    'session' => [
        'refresh_threshold' => 300,      // Refresh if expires within 5 minutes
        'dpop_key_rotation' => 86400,    // Rotate DPoP keys after 24 hours
    ],

    // OAuth settings
    'oauth' => [
        'disabled' => false,
        'prefix' => '/atp/oauth/',
        'private_key' => env('ATP_OAUTH_PRIVATE_KEY'),
        'kid' => env('ATP_OAUTH_KID', 'atp-client-key'),
    ],

    // HTTP client settings
    'http' => [
        'timeout' => 30,
        'retry' => [
            'times' => 3,
            'sleep' => 100,
        ],
    ],
];

Environment Variables#

ATP_CLIENT_NAME="My App"
ATP_CLIENT_URL="https://myapp.com"
ATP_CLIENT_REDIRECT_URI="https://myapp.com/auth/atp/callback"
ATP_OAUTH_PRIVATE_KEY="base64-encoded-private-key"
ATP_OAUTH_KID="atp-client-key"
ATP_REFRESH_THRESHOLD=300
ATP_HTTP_TIMEOUT=30

The ATP_OAUTH_KID is the Key ID used in your JWKS endpoint. Some developers may require this to match a specific value. The default is atp-client-key.

Credential Storage#

The package uses a CredentialProvider interface for token storage. The default ArrayCredentialProvider stores credentials in memory (lost on request end). For production applications, you need to implement persistent storage.

Why You Need a Credential Provider#

AT Protocol OAuth uses single-use refresh tokens. When a token is refreshed:

1. The old refresh token is immediately invalidated
2. A new refresh token is issued
3. You must store the new token before using it again

If you lose the refresh token, the user must re-authenticate. The CredentialProvider ensures tokens are safely persisted.

How Handle Resolution Works#

When you call Atp::as('user.bsky.social') or Atp::login('user.bsky.social', $password), the package automatically resolves the handle to a DID (Decentralized Identifier). The DID is then used as the storage key for credentials. This ensures consistency even if a user changes their handle.

If resolution fails (invalid handle, network error, etc.), a HandleResolutionException is thrown.

The CredentialProvider Interface#

interface CredentialProvider
{
    // Get stored credentials by DID
    public function getCredentials(string $did): ?Credentials;

    // Store credentials after initial OAuth or app password login
    public function storeCredentials(string $did, AccessToken $token): void;

    // Update credentials after token refresh (CRITICAL: refresh tokens are single-use!)
    public function updateCredentials(string $did, AccessToken $token): void;

    // Remove credentials (logout)
    public function removeCredentials(string $did): void;
}

Built-in Credential Providers#

The package includes several credential providers for different use cases:

CacheCredentialProvider - Uses Laravel's cache system (file cache by default):

// config/client.php
'credential_provider' => \SocialDept\AtpClient\Providers\CacheCredentialProvider::class,

SessionCredentialProvider - Credentials cleared when session expires or user logs out:

// config/client.php
'credential_provider' => \SocialDept\AtpClient\Providers\SessionCredentialProvider::class,

FileCredentialProvider - Stores credentials in storage/app/atp-credentials/:

// config/client.php
'credential_provider' => \SocialDept\AtpClient\Providers\FileCredentialProvider::class,

For production applications with multiple users, implement a database-backed provider as shown below.

Database Migration#

Create a migration for storing credentials:

php artisan make:migration create_atp_credentials_table

Schema::create('atp_credentials', function (Blueprint $table) {
    $table->id();
    $table->string('did')->unique();         // Decentralized identifier (primary key)
    $table->string('handle')->nullable();    // User's handle (e.g., user.bsky.social)
    $table->string('issuer')->nullable();    // PDS endpoint URL
    $table->text('access_token');            // JWT access token
    $table->text('refresh_token');           // Single-use refresh token
    $table->timestamp('expires_at');         // Token expiration time
    $table->json('scope')->nullable();       // Granted OAuth scopes
    $table->string('auth_type')->default('oauth'); // 'oauth' or 'legacy'
    $table->timestamps();
});

Implementing a Database Provider#

<?php

namespace App\Providers;

use App\Models\AtpCredential;
use SocialDept\AtpClient\Contracts\CredentialProvider;
use SocialDept\AtpClient\Data\AccessToken;
use SocialDept\AtpClient\Data\Credentials;
use SocialDept\AtpClient\Enums\AuthType;

class DatabaseCredentialProvider implements CredentialProvider
{
    public function getCredentials(string $did): ?Credentials
    {
        $record = AtpCredential::where('did', $did)->first();

        if (! $record) {
            return null;
        }

        return new Credentials(
            did: $record->did,
            accessToken: $record->access_token,
            refreshToken: $record->refresh_token,
            expiresAt: $record->expires_at,
            handle: $record->handle,
            issuer: $record->issuer,
            scope: $record->scope ?? [],
            authType: AuthType::from($record->auth_type),
        );
    }

    public function storeCredentials(string $did, AccessToken $token): void
    {
        AtpCredential::updateOrCreate(
            ['did' => $did],
            [
                'handle' => $token->handle,
                'issuer' => $token->issuer,
                'access_token' => $token->accessJwt,
                'refresh_token' => $token->refreshJwt,
                'expires_at' => $token->expiresAt,
                'scope' => $token->scope,
                'auth_type' => $token->authType->value,
            ]
        );
    }

    public function updateCredentials(string $did, AccessToken $token): void
    {
        AtpCredential::where('did', $did)->update([
            'access_token' => $token->accessJwt,
            'refresh_token' => $token->refreshJwt,
            'expires_at' => $token->expiresAt,
            'handle' => $token->handle,
            'issuer' => $token->issuer,
            'scope' => $token->scope,
            'auth_type' => $token->authType->value,
        ]);
    }

    public function removeCredentials(string $did): void
    {
        AtpCredential::where('did', $did)->delete();
    }
}

The AtpCredential Model#

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class AtpCredential extends Model
{
    protected $fillable = [
        'did',
        'handle',
        'issuer',
        'access_token',
        'refresh_token',
        'expires_at',
        'scope',
        'auth_type',
    ];

    protected $casts = [
        'expires_at' => 'datetime',
        'scope' => 'array',
    ];

    protected $hidden = [
        'access_token',
        'refresh_token',
    ];
}

Register Your Provider#

Update your config file:

// config/client.php

'credential_provider' => App\Providers\DatabaseCredentialProvider::class,

Or bind it in a service provider:

// app/Providers/AppServiceProvider.php

use SocialDept\AtpClient\Contracts\CredentialProvider;
use App\Providers\DatabaseCredentialProvider;

public function register(): void
{
    $this->app->singleton(CredentialProvider::class, DatabaseCredentialProvider::class);
}

Linking to Your User Model#

If you want to associate ATP credentials with your application's users:

// Migration
Schema::table('atp_credentials', function (Blueprint $table) {
    $table->foreignId('user_id')->nullable()->constrained()->cascadeOnDelete();
});

// AtpCredential model
public function user()
{
    return $this->belongsTo(User::class);
}

// User model
public function atpCredential()
{
    return $this->hasOne(AtpCredential::class);
}

Then update your provider to work with the authenticated user:

public function storeCredentials(string $did, AccessToken $token): void
{
    AtpCredential::updateOrCreate(
        ['did' => $did],
        [
            'user_id' => auth()->id(),  // Link to current user
            'handle' => $token->handle,
            'issuer' => $token->issuer,
            'access_token' => $token->accessJwt,
            'refresh_token' => $token->refreshJwt,
            'expires_at' => $token->expiresAt,
        ]
    );
}

Understanding the Credential Fields#

Handling Token Refresh Events#

When tokens are automatically refreshed, you can listen for events:

use SocialDept\AtpClient\Events\TokenRefreshed;

// In EventServiceProvider or via Event::listen()
Event::listen(TokenRefreshed::class, function (TokenRefreshed $event) {
    // The CredentialProvider.updateCredentials() is already called,
    // but you can do additional logging or notifications here
    Log::info("Token refreshed for: {$event->session->did()}");

    // Check if this is a legacy (app password) session
    if ($event->session->isLegacy()) {
        // Handle legacy sessions differently if needed
    }
});

Events#

The package dispatches events you can listen to:

OAuthUserAuthenticated#

Fired after a successful OAuth callback. Use this to create or update users in your application:

use SocialDept\AtpClient\Events\OAuthUserAuthenticated;
use SocialDept\AtpClient\Facades\Atp;

Event::listen(OAuthUserAuthenticated::class, function (OAuthUserAuthenticated $event) {
    // $event->token contains: did, accessJwt, refreshJwt, handle, issuer, expiresAt, scope

    // Check granted scopes
    if (in_array('atproto', $event->token->scope)) {
        // User granted AT Protocol access
    }

    // Fetch the user's profile
    $client = Atp::as($event->token->did);
    $profile = $client->bsky->actor->getProfile($event->token->did);

    // Create or update user in your database
    $user = User::updateOrCreate(
        ['did' => $event->token->did],
        [
            'handle' => $event->token->handle,
            'name' => $profile->json('displayName'),
            'avatar' => $profile->json('avatar'),
        ]
    );

    // Log them in
    Auth::login($user);
});

TokenRefreshing / TokenRefreshed#

Fired before and after automatic token refresh for both OAuth and legacy sessions. Use TokenRefreshing to invalidate your stored refresh token before it's used (refresh tokens are single-use):

use SocialDept\AtpClient\Events\TokenRefreshing;
use SocialDept\AtpClient\Events\TokenRefreshed;

// Before token refresh - invalidate old refresh token
Event::listen(TokenRefreshing::class, function (TokenRefreshing $event) {
    // $event->session gives access to did(), handle(), authType(), isLegacy(), etc.
    Log::info('Refreshing token for: ' . $event->session->did());
});

// After token refresh - new tokens available
Event::listen(TokenRefreshed::class, function (TokenRefreshed $event) {
    // $event->session - the session being refreshed
    // $event->token - the new AccessToken with fresh tokens
    // CredentialProvider.updateCredentials() is already called automatically
    Log::info('Token refreshed for: ' . $event->session->did());

    // Check auth type if needed
    if ($event->session->isLegacy()) {
        // Legacy (app password) session
    }
});

Scope Authorization#

The package provides Laravel-native authorization features for checking ATP OAuth scopes, similar to Laravel's Gate/Policy system.

Setup#

Have your User model implement the HasAtpSession interface:

use SocialDept\AtpClient\Contracts\HasAtpSession;

class User extends Authenticatable implements HasAtpSession
{
    public function getAtpDid(): ?string
    {
        return $this->atp_did; // or however you store the DID
    }
}

Route Middleware#

Protect routes by requiring specific scopes. Uses AND logic (all listed scopes required):

use Illuminate\Support\Facades\Route;

// Requires transition:generic scope
Route::post('/posts', [PostController::class, 'store'])
    ->middleware('atp.scope:transition:generic');

// Requires BOTH scopes
Route::post('/dm', [MessageController::class, 'store'])
    ->middleware('atp.scope:transition:generic,transition:chat.bsky');

AtpScope Facade#

Use the AtpScope facade for programmatic scope checks:

use SocialDept\AtpClient\Facades\AtpScope;

// Check if user has a scope
if (AtpScope::can('transition:generic')) {
    // ...
}

// Check if user has any of the scopes
if (AtpScope::canAny(['transition:generic', 'transition:chat.bsky'])) {
    // ...
}

// Check if user has all scopes
if (AtpScope::canAll(['atproto', 'transition:generic'])) {
    // ...
}

// Authorize or fail (throws/aborts based on config)
AtpScope::authorize('transition:generic');

// Check for a specific user
AtpScope::forUser($did)->authorize('transition:generic');

// Get all granted scopes
$scopes = AtpScope::granted();

Session Helper Methods#

The Session class also has convenience methods:

$session = Atp::as($did)->session();

$session->can('transition:generic');
$session->canAny(['transition:generic', 'transition:chat.bsky']);
$session->canAll(['atproto', 'transition:generic']);
$session->cannot('transition:chat.bsky');

Configuration#

Configure authorization failure behavior in config/client.php:

'scope_authorization' => [
    // What happens when scope check fails: 'abort', 'redirect', or 'exception'
    'failure_action' => ScopeAuthorizationFailure::Abort,

    // Redirect URL when failure_action is 'redirect'
    'redirect_to' => '/login',
],

Or via environment variables:

ATP_SCOPE_FAILURE_ACTION=abort
ATP_SCOPE_REDIRECT=/login

Extending the Client#

Add custom functionality to AtpClient by registering your own domain clients or request clients. Extensions are lazily instantiated on first access.

Register Extensions#

Register extensions in your service provider's boot() method:

use SocialDept\AtpClient\AtpClient;

// Add a new domain client: $client->analytics
AtpClient::extend('analytics', fn(AtpClient $atp) => new AnalyticsClient($atp));

// Add to an existing domain: $client->bsky->metrics
AtpClient::extendDomain('bsky', 'metrics', fn($bsky) => new MetricsClient($bsky));

Usage#

$client = Atp::as('user.bsky.social');

$client->analytics->trackEvent('post_created');
$client->bsky->metrics->getEngagement();

For complete documentation including creating custom clients, testing, and advanced patterns, see docs/extensions.md.

Available Commands#

# Generate OAuth private key
php artisan atp-client:generate-key

# Create a domain client extension
php artisan make:atp-client AnalyticsClient

# Create a request client extension for an existing domain
php artisan make:atp-request MetricsClient --domain=bsky

Requirements#

• PHP 8.2+
• Laravel 11 or 12
• socialdept/atp-schema ^0.2
• socialdept/atp-resolver ^1.0

Testing#

composer test

Resources#

• AT Protocol Documentation
• Bluesky API Docs
• CRYPTO.md - Cryptographic implementation details
• docs/extensions.md - Client extensions guide

Support & Contributing#

Found a bug or have a feature request? Open an issue.

Want to contribute? Check out the contribution guidelines.

Changelog#

Please see changelog for recent changes.

Credits#

• Miguel Batres - founder & lead maintainer
• All contributors

License#

AtpClient is open-source software licensed under the MIT license.

Built for the Federation - By Social Dept.