NAV Navbar
shell
  • Introduction
  • Authentication
  • ICO Updates
  • Models
  • Constants
  • Errors
  • Introduction

    Welcome to the Coin Jinja API! You can use our API to access coinjinja API endpoints, which can modify information of your ICO project.

    You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

    Authentication

    To authorize, use this code:

    # With shell, you can just pass the correct header with each request
    curl "api_endpoint_here"
      -H "Authorization: YOUR_API_KEY"
    

    Make sure to replace YOUR_API_KEY with your API key.

    Coinjinja API keys now are distributed through email, contact us with your business email (@same domain of your website) to ask for it.

    Coinjinja expects for the API key to be included in all API requests to the server in a header that looks like the following:

    Authorization: YOUR_API_KEY

    ICO Updates

    Post a new ICO Update

    curl -X POST "https://coinjinja.com/owner-api/ico-updates" \
      -H "Authorization: YOUR_API_KEY" \
      -d '{
      "accept_coins": ["BTC", "ETH"],
      "banner": "http://abc.io/images/banner.png",
      "slogan": "A great ICO!",
      "excerpt": "Our ICO enables digital security...",
      "desc": "Create a digital...",
      "ico_start": "2017-11-01",
      "ico_end": "2017-11-30",
      "industries": ["Platform", "Business services"],
      "initial_price": "1000 ABC",
      "logo": "http://abc.io/images/banner.png",
      "platform": "Ethereum",
      "raised_amount": "100,000 ABC",
      "sold_tokens": "10,000",
      "target_amount_max": "100,000,000 ABC",
      "target_amount_min": "20,000,000 ABC",
      "token_for_sale": "100,000,000",
      "token_type": "ERC20",
      "video": "http://youtube.com/watch?v=abcdef",
      "team": [
        {
          "avatar": "https://abc.io/avatar/kieran.jpg",
          "name": "Kieran Booth",
          "socials": {
            "LinkedIn": "https://www.linkedin.com/in/kieran-123"
          },
          "title": "Co-founder, CEO"
        },
        {
          "avatar": "https://abc.io/avatar/connor.jpg",
          "name": "Connor Newman",
          "socials": {
            "LinkedIn": "https://www.linkedin.com/in/connor-456"
          },
          "title": "Co-founder, COO & CTO, Blockchain developer"
        }
      ],
      "urls": {
        "Facebook": "https://www.facebook.com/abc/",
        "GitHub": "https://github.com/abc/abc-lib",
        "Medium": "https://medium.com/@abc/",
        "Reddit": "https://www.reddit.com/r/abc/",
        "Slack": "https://abc-slack-invite.herokuapp.com/",
        "Telegram": "https://t.me/abc",
        "Twitter": "https://twitter.com/abc",
        "Website": "http://abc.io/",
        "White paper": "http://abc.io/docs/wp.pdf"
      },
      "bonus": [
        {
          "time": "Pre-sale - Day 1",
          "value": "50%"
        },
        {
          "time": "Pre-sale - Day 2",
          "value": "40%"
        },
        {
          "time": "Pre-sale - Day 3",
          "value": "30%"
        }
      ],
      "feedback_email": "stuff@abc.com"
    }'
    

    The above command returns JSON structured like this:

    {
      "created_at": "2017-11-01T00:00:00Z",
      "id": "abcdef",
      "payload": {
        "accept_coins": [
          "BTC"
        ],
        ...
      },
      "status": "waiting",
      "updated_at": "2017-11-01T00:00:00Z"
    }
    

    You can post a update of your ICO project via this endpoint.

    Your update won't be reflected in our website immediately. You can check the review status of the update using the Get a specific ICO update API with the update ID given in the response of your request.

    HTTP Request

    POST https://coinjinja.com/owner-api/ico-updates

    Body Parameter

    A JSON object of ICO Update Payload. Only fields to update are needed.

    Returns

    Returns a ICO Update corresponding to your request, and raises an error otherwise.

    Get your ICO updates

    curl "https://coinjinja.com/owner-api/ico-updates"
      -H "Authorization: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    [
      {
        "created_at": "2017-11-02T00:00:00Z",
        "id": "abcdef",
        "payload": {
          "accept_coins": [
            "BTC"
          ],
          ...
        },
        "status": "waiting",
        "updated_at": "2017-11-02T00:00:00Z"
      },
      {
        "created_at": "2017-11-01T00:00:00Z",
        "id": "ghijkl",
        "payload": {
          ...
        },
        "status": "passed",
        "updated_at": "2017-11-01T00:00:00Z"
      }
    ]
    

    This endpoint retrieves your latest ICO updates.

    HTTP Request

    GET https://coinjinja.com/owner-api/ico-updates

    Returns

    Returns an array of ICO Update. If no updates are available, the resulting array will be empty.

    Get a specific ICO update

    curl "http://example.com/api/ico_updates/abcdef"
      -H "Authorization: YOUR_API_KEY"
    

    The above command returns JSON structured like this:

    {
      "created_at": "2017-11-02T00:00:00Z",
      "id": "abcdef",
      "payload": {
        "accept_coins": [
          "BTC"
        ],
        ...
      },
      "status": "waiting",
      "updated_at": "2017-11-02T00:00:00Z"
    }
    

    This endpoint retrieves a specific ICO update.

    HTTP Request

    GET https://coinjinja.com/owner-api/ico-updates/<ID>

    URL Parameters

    Parameter Description
    ID The ID of the ICO update to retrieve

    Returns

    Returns a ICO Update if a valid ID was provided, and raises an error otherwise.

    Models

    ICO Update

    The ICO update model provides review status of your ICO update request.

    Field Type Description
    id string The ID of your ICO update
    payload object The content of your request
    status string One of waiting, passed and rejected
    review string The review message, may including the reason why your update was rejected
    created_at datetime Created time
    updated_at datetime Updated time

    ICO Update Payload

    The ICO update payload model provides fields to update your ICO project. All fields you provided are optional.

    Field Type Description
    accept_coins [string] Accept coins, e.g. ["BTC", "ETH"]
    banner url A link to the banner image of your project
    slogan string The slogan of your project
    excerpt string A short description of your project
    desc html A detailed description
    ico_start string The start time of ICO
    ico_end string The end time of ICO
    industries [string] The industries your project belongs to, see Industries
    initial_price string The initial price
    logo url A link to the logo image of your project
    platform string The platform your ICO runs on
    raised_amount string The current raised amount
    sold_tokens string Sold tokens
    target_amount_max string The maximum target amount
    target_amount_min string The minimum target amount
    token_for_sale string Token for sale
    token_type string Token type, e.g. ERC20
    video url The video link of your project
    team [object] Your team members, see Team Member
    urls object Links for website, white paper, and social accounts, see URL Keys
    bonus [object] Your bonus plan, see Bonus Item
    feedback_email string The email address where our review feedback will be sent to

    Team Member

    This describes a member of your team.

    Field Type Description
    avatar url An image link of headshot/portrait
    name string Full name
    socials object Links for social accounts, see URL Keys
    title string Title of the member, e.g. CEO

    Bonus Item

    This describes an item of your bonus plan.

    Field Type Description
    time string For time definition, e.g. Pre-sale, Day 1, or First week
    value string The correspond bonus, e.g. 50% or 100 ABC

    Constants

    Industries

    Name Japanese Description
    Banking 銀行
    Business services ビジネスサービス
    Casino & Gambling カジノ・ギャンブル
    Charity 慈善
    Communication 通信
    Cryptocurrency 仮想通貨
    Education 教育
    Energy エネルギー
    Entertainment エンターテインメント
    Health 健康
    Infrastructure インフラ
    Internet インターネット
    Investment 投資
    Manufacturing 製造
    Media メディア
    Platform プラットフォーム
    Real estate 不動産
    Retail 小売
    Software ソフトウェア
    Sports スポーツ
    Tourism 観光
    Other その他

    URL Keys

    Available keys for URLs of website, white paper, and social accounts

    Name
    Website
    White paper
    BitcoinTalk
    Facebook
    Twitter
    Github
    Medium
    Reddit
    Slack
    Telegram
    VKontakte

    Errors

    The Coin Jinja API uses the following error codes:

    Error Code Meaning
    400 Bad Request -- Your request sucks.
    401 Unauthorized -- Your API key is wrong.
    403 Forbidden -- The resource requested is not under your administration.
    404 Not Found -- The specified resource could not be found.
    405 Method Not Allowed -- You tried to access a resource with an invalid method.
    429 Too Many Requests -- You're requesting too fast! Slow down!
    500 Internal Server Error -- We had a problem with our server. Please try again later.
    503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.