Environment Setup

Environment Setup

Overview

This guide explains how to set up your environment for accessing the Noodles API. It includes details on the available environments

API Environments

The Noodles API is available in two environments:

Environment	Base URL
Production	https://api.noodles.fi

Obtaining an API Key

An API key is required to authenticate, access and rate limit the API.

Steps to Get an API Key:

1. How to get API Key:

   • Visit our dashboard at https://dashboard.noodles.fi, log in or sign up for an account.

   • After logging in, navigate to the API Keys section and generate a new API key.

   • If you encounter any issues, contact us via telegram: @hiephho

2. Use the API Key:

   • Include the API key in the x-api-key header when making requests.

Example Usage

curl --location 'https://api.noodles.fi/api/v1/partner/ohlcv' \
--header 'Accept-Encoding: application/json' \
--header 'x-api-key: YOUR_API_KEY'

API Error Responses

Standard error responses for all API endpoints:

Invalid Parameters

Status Code: 400 Bad Request

{
    "code": 400,
    "message": "invalid pool address",
    "data": null
}

Unauthorized

Status Code: 401 Unauthorized

{
    "code": 401,
    "message": "Invalid API Key",
    "data": null
}

Rate Limited

Status Code: 429 Too Many Requests

{
    "code": 429,
    "message": "rate limit exceeded",
    "data": null
}

Internal server error

Status Code: 500 Internal Server Error

{
    "code": 500,
    "message": "internal server error",
    "data": null
}

---

Request to subscribe a higher tier plan

** Status Code:** 403 Forbidden

{
    "code": 403,
    "message": "Access denied. This endpoint requires a higher subscription tier.",
    "data": null
}

You can check list of api endpoints available for each subscription tier here: List API Endpoints

Notes

• Keep your API key secure and do not share it.

• Only use YOUR_API_KEY on backend server side.

• Contact support if you need help with API key generation.

---

See also: List API Endpoints