Vibe Coding Quickstart

Point your agent here to get started. Not intended for humans.

Ethos API Project Setup Instructions

You are setting up a new project that integrates with the Ethos Network API.

1. Environment Setup

Install Deno: curl -fsSL https://deno.land/install.sh | sh

Create deno.json with tasks for dev, check, and any cron jobs needed.

Deno documentation: https://docs.deno.com/

2. Project Structure

Create:

src/ 
  ethos-client.ts # API wrapper functions 
  main.ts         # Entry point 
  .env.example    # Document required env vars 
  deno.json

3. Ethos API Basics

Base URL: https://api.ethos.network/api/v2

Required header: X-Ethos-Client (identifies your app)

All requests should include headers: { "X-Ethos-Client": "your-app-name" }

Documentation:

• https://developers.ethos.network - Full API docs

• https://developers.ethos.network/llms.txt - LLM summary

• https://developers.ethos.network/llms-full.txt - LLM detailed reference

• https://api.ethos.network/docs/openapi.json - OpenAPI v3 spec

4. User Key Formats

When looking up users, these formats work:

• address:0x... - Ethereum address

• service:x.com:<userId> - Twitter by ID

• service:x.com:username:<handle> - Twitter by username

• service:discord:<userId> - Discord

5. Example Endpoints

• GET https://api.ethos.network/api/v2/score/address?address=0x... - Get credibility score

• GET https://api.ethos.network/api/v2/user/by/address/{address} - Get user profile

See full endpoint list: https://developers.ethos.network

6. Authentication

Most read endpoints are public (no auth). For authenticated user actions and login integration: https://developers.ethos.network/api-documentation/log-in-with-ethos

7. Reference Examples

Study these repos for patterns:

• https://github.com/trust-ethos/ethos-twitter-agent

• https://github.com/trust-ethos/ethos-spiderchart

• https://github.com/trust-ethos/log-in-with-ethos

• https://github.com/trust-ethos/ethos-anonymous-reviews

• https://github.com/trust-ethos/zora-ethos-sniper

• https://github.com/trust-ethos/ethosUSD-tempo