Crates.io | atrium-api |
lib.rs | atrium-api |
version | 0.23.2 |
source | src |
created_at | 2023-05-03 13:44:29.875533 |
updated_at | 2024-07-03 15:02:42.128951 |
description | API library for AT Protocol (Bluesky) |
homepage | |
repository | https://github.com/sugyan/atrium |
max_upload_size | |
id | 855467 |
size | 639,231 |
ATrium API is a Rust library that includes the definitions of XRPC requests and their associated input/output model types. These codes are generated from the Lexicon schema on atproto.com.
Any HTTP client that implements atrium_xrpc::HttpClient
can be used to handle XRPC requests. Since atrium_xrpc_client
provides several implementations, it is recommended to use one of them that fits your project requirements.
use atrium_api::client::AtpServiceClient;
use atrium_xrpc_client::reqwest::ReqwestClient;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = AtpServiceClient::new(ReqwestClient::new("https://bsky.social"));
let result = client
.service
.com
.atproto
.server
.create_session(
atrium_api::com::atproto::server::create_session::InputData {
auth_factor_token: None,
identifier: "alice@mail.com".into(),
password: "hunter2".into(),
}
.into(),
)
.await;
println!("{:?}", result);
Ok(())
}
AtpAgent
(agent
feature)While AtpServiceClient
can be used for simple XRPC calls, it is better to use AtpAgent
, which has practical features such as session management.
use atrium_api::agent::{store::MemorySessionStore, AtpAgent};
use atrium_xrpc_client::reqwest::ReqwestClient;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let agent = AtpAgent::new(
ReqwestClient::new("https://bsky.social"),
MemorySessionStore::default(),
);
agent.login("alice@mail.com", "hunter2").await?;
let result = agent
.api
.com
.atproto
.server
.get_session()
.await?;
println!("{:?}", result);
Ok(())
}
The AtpAgent
used in the above example is included in the agent
feature. atrium-api enables the agent
and bluesky
features by default. It is possible to opt-out if not needed.
agent
: enable the agent
module.bluesky
: enable bluesky-specific lexicon definitions and XRPC methods.
namespace-*
.