animify / dribbblejs

🏀 A Typescript-first Dribbble API library

A promise based, Typescript-first Dribbble API library.

Features

🤖 Full Typescript support

🌈 Familiar API setup

⚡️ Feather light

🚨 Proper error handling

🧘‍♀️ Framework agnostic

Getting Started

Installation

with Yarn

$ yarn add dribbblejs

or with NPM

$ npm install dribbblejs

Usage

import { Dribbble } from "dribbblejs";

const dribbble = new Dribbble({
  authToken: "xxxxxxxx"
});

API

User

Official User API Documentation

Get authenticated user

dribbble.user.get()

---

Projects

Official Projects API Documentation

Get list of projects

dribbble.projects.list()

Create a project

dribbble.projects.create({
    name: 'Project name', // *Required*
    description: 'Project description' // Optional
})

Update a project by id

dribbble.projects.update('883377', {
    name: 'New project name', // Optional
    description: 'New project description' // Optional
})

Delete a project by id

dribbble.projects.delete('883377')

---

Shots

Official Shots API Documentation

Get list of shots

dribbble.shots.list()

Get a shot by id

dribbble.shots.get('6432565')

Create a shot

dribbble.shots.create({
    image: imageFile // *Required*
    title: 'Shot title', // *Required*
    description: 'Shot description', // Optional
    low_profile: true, // Optional
    rebound_source_id: 6432542, // Optional
    scheduled_for: 1582391638790, // Optional
    tags: ['ui', 'illustration'], // Optional
    team_id: 3818924 // Optional
})

Update a shot by id

dribbble.shots.update('6432565', {
    title: 'New shot title', // Optional
    description: 'New shot description', // Optional
    low_profile: true, // Optional
    rebound_source_id: 6432542, // Optional
    scheduled_for: 1582391638790, // Optional
    tags: ['ui', 'illustration'], // Optional
    team_id: 3818924 // Optional
})

Delete a shot by id

dribbble.shots.delete('6432565')

---

Attachments API

Official Attachments API Documentation

Create attachment for a shot

dribbble.attachments.create('6432565', {
    file: attachmentFile // *Required*
})

Delete attachment id for a shot

dribbble.attachments.delete('1376676', '6432565')

---

License

Dribbblejs is MIT licensed.