Merging Market Data Swaps and Futures Sections

2024-04-05

Overview

• We are continuously striving to improve the clarity of our API documentation for all users. In line with this goal, we made a significant update to the organization of our market data sections.

Changes

• Effective immediately, we have merged the "Swaps" and "Futures" sections of our API documentation into a single, consolidated "Futures" section.
• Eventually we will be deprecating all of the /swaps endpoints, please read the Impact section below for more details.

Background

• Historically, some crypto exchanges used the term "Swaps" to refer to what are commonly recognized today as perpetual futures contracts. This terminology was more prevalent in the early days of crypto. Over time, the industry has standardized the use of the term "Futures" for both traditional and perpetual futures contracts. To align with current industry standards and reduce confusion, we have decided to merge these sections in our documentation.

Impact

• For API Users: The integration and interpretation of market data related to futures contracts will be streamlined. Users will no longer need to navigate two separate sections for information that pertains to essentially the same type of financial instruments.

• Simplified Documentation: This change will simplify our documentation, making it easier for users to find the information they need about futures contracts, whether they are traditional or perpetual.

• No API Endpoint Changes: It's important to note that this change is purely organizational within our documentation and there have been no changes to the endpoints themselves, so your existing implementations and integrations will continue to function without modification for the following endpoints:

  • Endpoint Name	Endpoint	API Documentation
    Exchanges - Pairs	https://api.amberdata.com/market/swaps/exchanges/information	https://docs.amberdata.io/reference/swaps-exchanges-pairs
    Exchanges - Reference	https://api.amberdata.com/market/swaps/exchanges/reference	https://docs.amberdata.io/reference/swaps-exchanges-refere
    OHLCV - Information	https://api.amberdata.com/market/swaps/ohlcv/information	https://docs.amberdata.io/reference/swaps-ohlcv-information
    OHLCV - Latest	https://api.amberdata.com/market/swaps/ohlcv/{instrument}/latest	https://docs.amberdata.io/reference/swaps-ohlcv-latest
    OHLCV - Historical	https://api.amberdata.com/market/swaps/ohlcv/{instrument}/historical	https://docs.amberdata.io/reference/swaps-ohlcv-historical

    
    

• Endpoint Deprecation Notice: The following endpoints will be deprecated as part of our efforts to streamline and standardize our API offerings. We encourage users to transition to the new endpoint as soon as possible:

  • Deprecated Endpoint Name	Deprecated Endpoint	New Endpoint	Old Documentation Link
    Swaps - Trades Information	https://api.amberdata.com/market/swaps/trades/information	https://api.amberdata.com/markets/futures/trades/information	https://docs.amberdata.io/reference/swaps-trades-information
    Swaps - Trades Historical	https://api.amberdata.com/market/swaps/trades/{instrument}/historical	https://api.amberdata.com/markets/futures/trades/{instrument}	https://docs.amberdata.io/reference/swaps-trades-historical
    Swaps - Tickers Information	https://api.amberdata.com/market/swaps/tickers/information	https://api.amberdata.com/markets/futures/tickers/information	https://docs.amberdata.io/reference/swaps-tickers-information
    Swaps - Tickers Latest	https://api.amberdata.com/market/swaps/tickers/{instrument}/latest	https://api.amberdata.com/markets/futures/tickers/{instrument}	https://docs.amberdata.io/reference/swaps-tickers-latest
    Swaps - Tickers Historical	https://api.amberdata.com/market/swaps/tickers/{instrument}/historical	https://api.amberdata.com/markets/futures/tickers/{instrument}	https://docs.amberdata.io/reference/swaps-tickers-historical
    Swaps - Order Book Events Information	https://api.amberdata.com/market/swaps/order-book-events/information	https://api.amberdata.com/markets/futures/order-book-snapshots/information	https://docs.amberdata.io/reference/swaps-order-book-events-information
    Swaps - Order Book Events Historical	https://api.amberdata.com/market/swaps/order-book-events/{instrument}/historical	https://api.amberdata.com/markets/futures/order-book-events/{instrument}	https://docs.amberdata.io/reference/swaps-order-book-events-historical
    Swaps - Order Book Snapshots Information	https://api.amberdata.com/market/swaps/order-book-snapshots/information	https://api.amberdata.com/markets/futures/order-book-snapshots/information	https://docs.amberdata.io/reference/swaps-order-book-snapshots-information
    Swaps - Order Book Snapshots Historical	https://api.amberdata.com/market/swaps/order-book-snapshots/{instrument}/historical	https://api.amberdata.com/markets/futures/order-book-snapshots/{instrument}	https://docs.amberdata.io/reference/swaps-order-book-snapshots-historical
    Swaps - Open Interest Information	https://api.amberdata.com/market/swaps/open-interest/information	https://api.amberdata.com/markets/futures/open-interest/information	https://docs.amberdata.io/reference/swaps-open-interest-information
    Swaps - Open Interest Latest	https://api.amberdata.com/market/swaps/open-interest/{instrument}/latest	https://api.amberdata.com/markets/futures/open-interest/{instrument}	https://docs.amberdata.io/reference/swaps-open-interest-latest
    Swaps - Open Interest Historical	https://api.amberdata.com/market/swaps/open-interest/{instrument}/historical	https://api.amberdata.com/markets/futures/open-interest/{instrument}	https://docs.amberdata.io/reference/swaps-open-interest-historical
    Swaps - Liquidations Information	https://api.amberdata.com/market/swaps/liquidations/information	https://api.amberdata.com/markets/futures/liquidations/information	https://docs.amberdata.io/reference/swaps-liquidations-information
    Swaps - Liquidations Latest	https://api.amberdata.com/market/swaps/liquidations/{instrument}/latest	https://api.amberdata.com/markets/futures/liquidations/{instrument}	https://docs.amberdata.io/reference/swaps-liquidations-latest
    Swaps - Liquidations Historical	https://api.amberdata.com/market/swaps/liquidations/{instrument}/historical	https://api.amberdata.com/markets/futures/liquidations/{instrument}	https://docs.amberdata.io/reference/swaps-liquidations-historical
    Swaps - Insurance Fund Information	https://api.amberdata.com/market/swaps/insurance-fund/information	https://api.amberdata.com/markets/futures/insurance-fund/information	https://docs.amberdata.io/reference/swaps-insurance-fund-information
    Swaps - Insurance Fund Latest	https://api.amberdata.com/market/swaps/insurance-fund/{instrument}/latest	https://api.amberdata.com/markets/futures/insurance-fund/{instrument}	https://docs.amberdata.io/reference/swaps-insurance-fund-latest
    Swaps - Insurance Fund Historical	https://api.amberdata.com/market/swaps/insurance-fund/{instrument}/historical	https://api.amberdata.com/markets/futures/insurance-fund/{instrument}	https://docs.amberdata.io/reference/swaps-insurance-fund-historical
    Swaps - Funding Rates Information	https://api.amberdata.com/market/swaps/funding-rates/information	https://api.amberdata.com/markets/futures/funding-rates/information	https://docs.amberdata.io/reference/swaps-funding-rates-information
    Swaps - Funding Rates Latest	https://api.amberdata.com/market/swaps/funding-rates/{instrument}/latest	https://api.amberdata.com/markets/futures/funding-rates/{instrument}	https://docs.amberdata.io/reference/swaps-funding-rates-latest
    Swaps - Funding Rates Historical	https://api.amberdata.com/market/swaps/funding-rates/{instrument}/historical	https://api.amberdata.com/markets/futures/funding-rates/{instrument}	https://docs.amberdata.io/reference/swaps-funding-rates-historical

    
    

Support

• For any questions or assistance during migration, please contact our support team at [email protected].