Git Product home page Git Product logo

inistock-api's Introduction

Inistock Portfolio management platform - REST API

This is a Portfolio management API that allows you to create your profile and add all your investments together in one place.

Install

Clone the project and start building a development environment

  1. Install the dependencies of project
$ pip install -r requirements.txt
  1. Create the .env file and add the variables
POSTGRES_DB_NAME=''
POSTGRES_DB_USERNAME=''
POSTGRES_DB_PASSWORD=''
POSTGRES_HOST=''
POSTGRES_PORT=''

Run the app

 $ python manage.py runserver

REST API - ENDPOINT STRUCTURE

Endpoint Method Description
/v1/person POST Create a new person
/v1/person/<person_id> GET Retrieve a person based on id
/v1/person/<person_id> PATCH Update a person
/v1/share GET Retrieve a list of shares
/v1/share/<share_id> GET Retrieve a share
/v1/share/<share_id> DELETE Delete a share
/v1/share/<share_id> PATCH Update a share

Errors

The Inistock API uses conventional HTTP response codes to indicate errors, and includes more detailed information on the exact nature of an error in the HTTP response.


HTTP RESPONSE CODES

RESPONSE CODE MESSAGE
200 OK All is well
201 CREATED A resource has been created
400 BAD REQUEST Your request has missing arguments
405 METHOD NOT ALLOWED You are using an incorrect HTTP verb
404 NOT FOUND The endpoint requested does not exist
500 INTERNAL SERVER ERROR Something is wrong on our end

License & Author

License 2020 © MIHAIL BUTNARU

Made by Mihail Butnaru

inistock-api's People

Contributors

mihailbutnaru avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.