Skip to content
EthosEthosDevelopers

Vibe Coding Quickstart

Ethos API Project Setup Instructions

Section titled “Ethos API Project Setup Instructions”

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

1. Environment Setup

Section titled “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

Section titled “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

Section titled “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:

4. User Key Formats

Section titled “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

To cite a person, link their profile page: https://app.ethos.network/profile/x/<handle> or https://app.ethos.network/profile/<address>

5. Example Endpoints

Section titled “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

Section titled “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

Section titled “7. Reference Examples”

Study these repos for patterns: