API Documentation (1.0)

Download OpenAPI specification:Download

Comments

Create comment

path Parameters

poop_id

number

Example: 1

header Parameters

Accept	any Example: application/json
Content-Type	any Example: application/json

Request Body schema: application/json

Schema not provided

Responses

Request samples

Payload

Content type

application/json

{"comment": {"comment": "Iusto hic eos autem."
}
}

Response samples

200

Content type

application/json; charset=utf-8

{"comment": {"id": 2,
"created_at": "2021-05-24T16:10:57.032Z",
"username": "pooper1",
"comment": "Iusto hic eos autem.",
"avatar": null,
"user_id": 1,
"photo": null,
"giphy": null
}
}

Get comments

path Parameters

poop_id

number

Example: 2

header Parameters

Accept

any

Example: application/json

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"comments": [{"id": 3,
"created_at": "2021-05-24T16:10:57.128Z",
"username": "pooper3",
"comment": "Esse voluptatem repellendus explicabo.",
"avatar": null,
"user_id": 3,
"photo": null,
"giphy": null
}
]
}

Delete comment

path Parameters

poop_id	number Example: 3
id	number Example: 4

header Parameters

Accept	any Example: application/json
Content-Type	any Example: application/x-www-form-urlencoded

Responses

Response samples

200

Content type

application/json; charset=utf-8

{ }

Feed

Get feed

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"poops": [{"id": 7,
"avatar": null,
"comments_count": 0,
"created_at": "2021-05-24T16:10:57.315Z",
"followers_count": 0,
"latitude": -69.56721541420575,
"liked_by_you": false,
"longitude": -100.9649125848704,
"note": "Voluptatem mollitia et incidunt.",
"original_latitude": null,
"original_longitude": null,
"photos": [ ],
"photos_full": [ ],
"pin_color": null,
"place": "odio",
"rating": 2,
"sticker": null,
"user_id": 7,
"username": "pooper7"
},
{"id": 6,
"avatar": null,
"comments_count": 0,
"created_at": "2021-05-24T16:10:57.312Z",
"followers_count": 0,
"latitude": 40.06340278081598,
"liked_by_you": false,
"longitude": -87.73052433694977,
"note": "Exercitationem aliquam soluta unde.",
"original_latitude": null,
"original_longitude": null,
"photos": [ ],
"photos_full": [ ],
"pin_color": null,
"place": "dicta",
"rating": 5,
"sticker": null,
"user_id": 7,
"username": "pooper7"
},
{"id": 5,
"avatar": null,
"comments_count": 0,
"created_at": "2021-05-24T16:10:57.310Z",
"followers_count": 0,
"latitude": 33.56202336613862,
"liked_by_you": false,
"longitude": 120.8626000377677,
"note": "Doloribus dolor est non.",
"original_latitude": null,
"original_longitude": null,
"photos": [ ],
"photos_full": [ ],
"pin_color": null,
"place": "consequatur",
"rating": 3,
"sticker": null,
"user_id": 7,
"username": "pooper7"
},
{"id": 4,
"avatar": null,
"comments_count": 0,
"created_at": "2021-05-24T16:10:57.308Z",
"followers_count": 0,
"latitude": -88.68334121380326,
"liked_by_you": false,
"longitude": -137.1514028252679,
"note": "Eos molestias mollitia alias.",
"original_latitude": null,
"original_longitude": null,
"photos": [ ],
"photos_full": [ ],
"pin_color": null,
"place": "iste",
"rating": 1,
"sticker": null,
"user_id": 7,
"username": "pooper7"
}
],
"user": {"username": "pooper7",
"id": 7,
"avatar": null,
"show_map_selfies_in_feed": false,
"show_compact_feed": false
}
}

Followers

Get Followers

path Parameters

user_id

number

Example: 8

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"users": [ ]
}

Followings

Get followings

path Parameters

user_id

number

Example: 10

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"users": [{"id": 11,
"avatar": null,
"pin_color": null,
"poops_count": 0,
"user_follows_you": false,
"username": "pooper11",
"you_follow_user": true
}
]
}

Create following

header Parameters

Content-Type

any

Example: application/json

Request Body schema: any

Schema not provided

Responses

Request samples

Payload

Content type

any

{
  "user": {
    "id": 15
  }
}

Response samples

200

Content type

application/json; charset=utf-8

{ }

Delete following

header Parameters

Content-Type

any

Example: application/json

Request Body schema: any

Schema not provided

Responses

Request samples

Payload

Content type

any

{
  "user": {
    "id": 19
  }
}

Response samples

200

Content type

application/json; charset=utf-8

{ }

Leagues

Get leagues

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"leagues": [{"id": 1,
"active_from": null,
"active_to": null,
"chat_enabled": true,
"created_at": "2021-05-24T16:10:57.677Z",
"current_user_rank": 1,
"is_public": false,
"join_code": "54694a0044",
"league_comments_count": 0,
"name": "Cherry",
"participants": 1,
"score_type": "poop_count",
"username": "pooper20"
}
]
}

Create league

header Parameters

Content-Type

any

Example: application/json

Request Body schema: any

Schema not provided

Responses

Request samples

Payload

Content type

any

{
  "league": {
    "name": "Jefferson",
    "is_public": true,
    "join_code": "5055e431a9"
  }
}

Response samples

201

Content type

application/json; charset=utf-8

{"id": 5,
"name": "Jefferson",
"is_public": true,
"join_code": "vecbovyof5820",
"user_id": 22,
"active_from": null,
"active_to": null,
"created_at": "2021-05-24T16:10:57.753Z",
"updated_at": "2021-05-24T16:10:57.753Z",
"league_participants_count": 1,
"score_type": "poop_count",
"league_comments_count": 0,
"chat_enabled": true
}

Joinable leagues

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"leagues": [{"id": 7,
"active_from": null,
"active_to": null,
"chat_enabled": true,
"created_at": "2021-05-24T16:10:57.812Z",
"is_public": true,
"join_code": "52a36a23d4",
"league_comments_count": 0,
"name": "Ian",
"participants": 1,
"score_type": "poop_count",
"username": "pooper25"
}
]
}

Update league

path Parameters

id	number Example: 8

header Parameters

Content-Type

any

Example: application/json

Request Body schema: any

Schema not provided

Responses

Request samples

Payload

Content type

any

{
  "league": {
    "is_public": false
  }
}

Response samples

200

Content type

application/json; charset=utf-8

{"user_id": 26,
"id": 8,
"is_public": false,
"name": "Johana",
"score_type": "poop_count",
"join_code": "cdb2511a65",
"active_from": null,
"active_to": null,
"created_at": "2021-05-24T16:10:57.845Z",
"updated_at": "2021-05-24T16:10:57.845Z",
"league_participants_count": 1,
"league_comments_count": 0,
"chat_enabled": true
}

Delete league

path Parameters

id	number Example: 10

header Parameters

Content-Type

any

Example: application/x-www-form-urlencoded

Responses

Join public league

path Parameters

league_id

number

Example: 13

header Parameters

Content-Type

any

Example: application/json

Request Body schema: any

Schema not provided

Responses

Request samples

Payload

Content type

any

{}

Response samples

200

Content type

application/json; charset=utf-8

{"id": 13,
"name": "Karlyn",
"is_public": true,
"join_code": "3a6db4ed40",
"user_id": 31,
"active_from": null,
"active_to": null,
"created_at": "2021-05-24T16:10:57.933Z",
"updated_at": "2021-05-24T16:10:57.933Z",
"league_participants_count": 2,
"score_type": "poop_count",
"league_comments_count": 0,
"chat_enabled": true
}

Leave leagues

path Parameters

league_id

number

Example: 14

header Parameters

Content-Type

any

Example: application/x-www-form-urlencoded

Responses

Response samples

200

Content type

application/json; charset=utf-8

{ }

Join private league by code

header Parameters

Content-Type

any

Example: application/json

Request Body schema: any

Schema not provided

Responses

Request samples

Payload

Content type

any

{
  "join_code": "015edc73be"
}

Response samples

200

Content type

application/json; charset=utf-8

{"id": 17,
"name": "Ronny",
"is_public": true,
"join_code": "015edc73be",
"user_id": 35,
"active_from": null,
"active_to": null,
"created_at": "2021-05-24T16:10:58.022Z",
"updated_at": "2021-05-24T16:10:58.022Z",
"league_participants_count": 2,
"score_type": "poop_count",
"league_comments_count": 0,
"chat_enabled": true
}

Me

Get poops

header Parameters

Accept

any

Example: application/json

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"poops": [{"id": 8,
"comments_count": 0,
"created_at": "2021-05-24T16:10:58.052Z",
"device": {"id": 37
},
"followers_count": 0,
"latitude": -43.50893106492578,
"longitude": -13.84215363271284,
"note": "Expedita quidem dolorem aut.",
"original_latitude": null,
"original_longitude": null,
"pin_color": null,
"place": "ut",
"rating": 3,
"sticker": null,
"user_id": 36,
"username": "pooper36"
}
],
"user": {"username": "pooper36",
"avatar": null,
"id": 36
}
}

Poops

Create poop

header Parameters

Accept	any Example: application/json
Content-Type	any Example: application/json

Request Body schema: application/json

Schema not provided

Responses

Request samples

Payload

Content type

application/json

{"poop": {"latitude": -38.8190322902643,
"longitude": 91.82010189409641,
"note": "Id architecto ratione quia.",
"place": "omnis",
"rating": 3
}
}

Response samples

200

Content type

application/json; charset=utf-8

{"poop": {"id": 10,
"latitude": -38.8190322902643,
"longitude": 91.82010189409641,
"note": "Id architecto ratione quia.",
"place": "omnis",
"rating": 3,
"created_at": "2021-05-24T16:10:58.112Z",
"username": "pooper38",
"user_id": 38,
"followers_count": 0,
"pin_color": null,
"comments_count": 0,
"nearby_places": [ ],
"device": {"id": 39
}
}
}

Like poop

header Parameters

Accept	any Example: application/json
Content-Type	any Example: application/json

Request Body schema: application/json

Schema not provided

Responses

Request samples

Payload

Content type

application/json

{"id": 11
}

Response samples

200

Content type

application/json; charset=utf-8

{ }

Unlike poop

header Parameters

Accept	any Example: application/json
Content-Type	any Example: application/json

Request Body schema: application/json

Schema not provided

Responses

Request samples

Payload

Content type

application/json

{"id": 12
}

Response samples

200

Content type

application/json; charset=utf-8

{ }

Get poops

header Parameters

Accept

any

Example: application/json

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"poops": [{"id": 13,
"comments_count": 0,
"created_at": "2021-05-24T16:10:58.275Z",
"device": {"id": 45
},
"followers_count": 0,
"latitude": -26.030342446231,
"longitude": 125.1557591254755,
"note": "Voluptas delectus quos libero.",
"original_latitude": null,
"original_longitude": null,
"pin_color": null,
"place": "molestiae",
"rating": 2,
"sticker": null,
"user_id": 44,
"username": "pooper44"
}
],
"user": {"username": "pooper44",
"avatar": null,
"id": 44
}
}

Update poop

path Parameters

id	number Example: 14

header Parameters

Accept	any Example: application/json
Content-Type	any Example: application/json

Request Body schema: application/json

Schema not provided

Responses

Request samples

Payload

Content type

application/json

{"poop": {"note": "hi",
"rating": 5,
"place": "47808 Jesus Fort"
}
}

Response samples

200

Content type

application/json; charset=utf-8

{"poop": {"id": 14,
"latitude": 26.52212030214525,
"longitude": -119.4380601320595,
"note": "hi",
"place": "47808 Jesus Fort",
"rating": 5,
"created_at": "2021-05-24T16:10:58.317Z",
"username": "pooper46",
"user_id": 46,
"followers_count": 0,
"liked_by_you": false,
"pin_color": null,
"comments_count": 1,
"photos": [ ],
"photos_full": [ ],
"device": {"id": 47
}
}
}

Delete poop

path Parameters

id	number Example: 15

header Parameters

Accept	any Example: application/json
Content-Type	any Example: application/json

Request Body schema: application/json

Schema not provided

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200

Content type

application/json; charset=utf-8

{ }

Devices

Create device

header Parameters

Content-Type

any

Example: application/x-www-form-urlencoded

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"device": {"id": 7,
"token": "wYCzAezox4sDimVNpcNLwD1j",
"poops": [ ],
"user": null
}
}

Users

Create user

header Parameters

Content-Type

any

Example: application/json

Request Body schema: any

Schema not provided

Responses

Request samples

Payload

Content type

any

{
  "user": {
    "username": "pooper52",
    "email": "[email protected]",
    "password": "123123",
    "password_confirmation": "123123"
  }
}

Response samples

200

Content type

application/json; charset=utf-8

{"user": {"id": 52,
"username": "pooper52",
"poops_count": 0,
"followers_count": 0,
"followings_count": 0,
"pin_color": null,
"country_count": 0,
"badges_count": 0,
"poops": [ ]
}
}

Update user

path Parameters

id	number Example: 55

header Parameters

Content-Type

any

Example: application/json

Request Body schema: any

Schema not provided

Responses

Request samples

Payload

Content type

any

{
  "user": {
    "show_poops_world": true
  }
}

Response samples

200

Content type

application/json; charset=utf-8

{"user": {"id": 55,
"username": "pooper55",
"poops_count": 0,
"followers_count": 0,
"followings_count": 0,
"pin_color": null,
"country_count": 0,
"created_at": "2021-05-24T16:10:58.560Z",
"email": "",
"show_poops_world": true,
"show_poops_followers": true,
"show_push_poops_following": true,
"show_push_new_followers": true,
"show_push_new_comments": true,
"is_private": true,
"enable_photos": true,
"show_following_poops_photos": true,
"share_poops_leagues": false,
"show_push_league_updates": true,
"avatar": null,
"shrine_avatar": null,
"badges_count": 0,
"show_map_selfies_in_feed": false,
"show_compact_feed": false,
"account_days": 0
}
}

Get users

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"user": {"id": 56,
"username": "pooper56",
"poops_count": 5,
"followers_count": 0,
"followings_count": 0,
"pin_color": null,
"country_count": 0,
"created_at": "2021-05-14T16:10:58.588Z",
"email": "itaque",
"show_poops_world": false,
"show_poops_followers": true,
"show_push_poops_following": true,
"show_push_new_followers": true,
"show_push_new_comments": true,
"is_private": true,
"enable_photos": true,
"show_following_poops_photos": true,
"share_poops_leagues": false,
"show_push_league_updates": true,
"avatar": null,
"shrine_avatar": null,
"badges_count": 1,
"show_map_selfies_in_feed": false,
"show_compact_feed": false,
"account_days": 10
}
}

Get user

path Parameters

id	number Example: 59

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"user": {"id": 59,
"username": "pooper59",
"poops_count": 0,
"followers_count": 0,
"followings_count": 0,
"pin_color": null,
"country_count": 0,
"created_at": "2021-05-24T16:10:58.654Z",
"account_days": 0,
"you_follow_user": false,
"user_follows_you": false,
"you_blocked_user": false,
"is_private": false,
"avatar": null
}
}

Get stats

path Parameters

user_id

number

Example: 60

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"account_days": 10,
"poops": {"per_day": 0.5,
"per_month": 3.5,
"per_year": 182.5
}
}

Get badges

path Parameters

user_id

number

Example: 62

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"badges": [{"id": 6,
"achievement": {"id": 6,
"description": "Dolor ea quae assumenda.",
"icon": "💩",
"image": "💩",
"name": "aut"
},
"created_at": "2021-05-24T16:10:58.735Z",
"updated_at": "2021-05-24T16:10:58.735Z"
}
]
}

World

Get world poops

header Parameters

Accept

any

Example: application/json

Responses

Response samples

200

Content type

application/json; charset=utf-8

{"user": {"username": "pooper64",
"id": 64
},
"poops": [{"id": 23,
"created_at": "2021-05-24T16:10:58.784Z",
"latitude": 11.10900880001839,
"longitude": 24.31278575378678,
"note": "Ad quia velit aut.",
"pin_color": null,
"place": "illo",
"rating": 4,
"sticker": null,
"user_id": 65,
"username": "pooper65"
},
{"id": 22,
"created_at": "2021-05-24T16:10:58.771Z",
"latitude": 42.22480189196443,
"longitude": -65.62827199540392,
"note": "Vel est temporibus sit.",
"pin_color": null,
"place": "ut",
"rating": 2,
"sticker": null,
"user_id": 64,
"username": "pooper64"
}
]
}