Skip to content

Latest commit

 

History

History
260 lines (175 loc) · 6.35 KB

API.md

File metadata and controls

260 lines (175 loc) · 6.35 KB

c4-cams

note: this is slightly outdated, it is still usable, but some into on camera objects may not be accurate

API documentation:

note: you are limited to 120 API calls per minute

note2: all urls in this doc were pulled from the turbo/c4 list and slightly altered.

0. Understanding Camera Objects

Camera objects are composed of 7 parts

  • _id
    • the UUID of the camera object/post
    • eg: d475a62d-b718-41ff-b427-911f71d33755
  • urlFull
    • the full url of a camera stream
    • eg: http://81.13.70.54:8001/mjpg/video.mjpg?COUNTER/
  • url
    • a shortened version of the url
    • a full url can be converted to a short url with the following regex /(:\/\/)(.+?)(?=\/)/g
    • eg: 81.13.70.54:8001
  • upvotes
    • amount of upvotes a post has, positive integer
  • downvotes
    • amount of downvotes a post has, positive integer
  • reports
    • amount of reports a post has, posiitive integer
    • a user only counts as a view every 30 minutes
    • posts are autoreported when they fail to load, aswell as when the user clicks report
  • views
    • amount of times the a post has been viewed
    • a user only counts as a view every 30 minutes
  • time
    • time in ms that it took for a HEAD request to the URL to come back OK
    • only used in /api/random
    • use this to specify at what interval to manually update static cams (round it as to not overload the camera)

now that we know that heres an example of a camera object

{
  "_id":"d475a62d-b718-41ff-b427-911f71d33755",
  "urlFull":"http://81.13.70.54:8001/mjpg/video.mjpg?COUNTER/",
  "url":"81.13.70.54:8001",
  "upvotes":1,
  "downvotes":3,
  "reports":0,
  "views":1
}

now onto the API calls

1. GET /api/ping

returns the text 'pong'

required? query parameter use
❌ delay delay in ms for sending the text
example

GET /api/ping?delay=5000

waits 5 seconds and returns the text pong

2. POST /api/find

search for cams

required? query parameter use
✔️ type type of search to preform. 0 means to search by the camera objects UUID. 1 means to search by the short url. 2 means to search by the full url
✔️ query what to search for, string
example

the following 3 API requests all return the same thing

GET /api/find?type=0&query=d475a62d-b718-41ff-b427-911f71d33755

(searches for uuid d475a62d-b718-41ff-b427-911f71d33755)

GET /api/find?type=1&query=81.13.70.54:8001

(searches for short url 81.13.70.54:8001)

GET /api/find?type=2&query=http://81.13.70.54:8001/mjpg/video.mjpg?COUNTER/

(searches for full url http://81.13.70.54:8001/mjpg/video.mjpg?COUNTER/)

They all return the same camera object

{"_id":"d475a62d-b718-41ff-b427-911f71d33755",
"url":"81.13.70.54:8001",
"urlFull":"http://81.13.70.54:8001/mjpg/video.mjpg?COUNTER/",
"upvotes":17,
"downvotes":2,
"reports":0,
"views":37}

3. GET /api/random

returns a random camera object and the time it took to make a HEAD request

this does NOT instantly return a value

on the server-end it checks if the url is valid and regenerates based on that

it could take up to 15 seconds to return a value in worst-case scenario

required? query parameter use
❌ id socket.io client ID to send fail messages to, NOT REQUIRED
example

GET /api/random

{
  "_id":"57fc3f3b-d230-41d4-b8ef-695da192a893",
  "url":"82.26.242.70:60001",
  "urlFull":"http://82.26.242.70:60001/cgi-bin/snapshot.cgi?chn=0&u=admin&p=&q=0/",
  "upvotes":0,
  "downvotes":0,
  "reports":0,
  "views":0,
  "time": 500
 }

4. GET /api/top

returns an array of camera objects for the top 50 highest rated posts

example

GET /api/top

[
  {
    "_id":"202340ed-5fbe-4dcb-817b-d9a9f5ce2c52",
   "url":"25.116.100.10:80",
   "urlFull":"http://25.116.100.10:80/axis-cgi/mjpg/video.cgi?camera=&resolution=640x480/",
   "upvotes":10,
   "downvotes":2,
   "reports":0,
   "views":1
  },
  
  {
    "_id":"a39d3ed7-0994-4c13-97eb-1d12a3325b3b",
    "url":"86.105.134.7:60001",
    "urlFull":"http://86.105.134.7:60001/cgi-bin/snapshot.cgi?chn=0&u=admin&p=&q=0/",
    "upvotes":5,
    "downvotes":1,
    "reports":0,
    "views":1
    },
  ...
]

5. POST /api/add

add a camera to the main list of cams. It will be available from /api/random and can show in /api/top

ratelimited to 3 POST's per 10 minutes (errors dont count towards this)

required? query parameter use
✔️ url direct link to camera's stream. must be in a format that can be in an <img> tag
example

POST /api/add?url=http://82.45.80.216:8000/axis-cgi/mjpg/video.cgi?camera=&amp;amp;resolution=640x480/

returns the newly created camera object's UUID

{
  "uuid":"21044371-fdd1-4c88-aed2-a35e8e245ab5",
  "response":"OK",
  "code":200
}

6. POST /api/upvote

upvotes a given post

required? query parameter use
✔️ uuid the uuid of the post to upvote
example

POST /api/upvote?uuid=d475a62d-b718-41ff-b427-911f71d33755

this will upvote the post with the uuid of d475a62d-b718-41ff-b427-911f71d33755

7. POST /api/downvote

upvotes a given post

required? query parameter use
✔️ uuid the uuid of the post to downvote
example

POST /api/downvote?uuid=d475a62d-b718-41ff-b427-911f71d33755

this will downvote the post with the uuid of d475a62d-b718-41ff-b427-911f71d33755

7. POST /api/unvote

removes vote you made from a post

required? query parameter use
✔️ uuid the uuid of the post to unvote
example

POST /api/unvote?uuid=d475a62d-b718-41ff-b427-911f71d33755

this will remove your vote (either upvote or downvote) from the post with uuid d475a62d-b718-41ff-b427-911f71d33755

9. POST /api/report

report a given post for being a dead link

note: you can only report a post once, trying to report a post multiple times will return error code 0

required? query parameter use
✔️ uuid the uuid of the post to report
example

POST /api/report?uuid=d475a62d-b718-41ff-b427-911f71d33755

this will report the post with the uuid of d475a62d-b718-41ff-b427-911f71d33755