CryptoLocally
CryptoLocally
CryptoLocally
CryptoLocally
CryptoLocally Public API Documentation
Powered by GitBook

CryptoLocally Public API Documentation

get
Get offer list

https://cryptolocally.com/api/tradeadvert/open/list
This endpoint allows you to get all offers on CryptoLocally
Request
Response
Request
Query Parameters
limit
optional
string
Max number of offers you are trying to load
offset
optional
string
Offset
privateKey
required
string
Private key for API auth (email [email protected] if you don't have a key pair)
publicKey
required
string
Public key for API auth (email [email protected] if you don't have a key pair)
order
optional
string
price, reputation, or lastActive. price orders by best price, reputation orders by reputation on the site, and lastActive orders by the most active offer creators.
offer_type
optional
boolean
buy or sell. Use buy if your users are trying to buy crypto. Otherwise, use sell.
Response
200: OK
Offer list successfully retrieved
{"offers":[],"limit":1,"offset":1,"amountOfOffers":521}
​
offers:
{
    externalId: string — unique ID for each offer
    offerAndPaymentMethods: string[] — Array of payment methods such as Bank Transfer, PayPal, etc
    offerType: string — buy or sell
    cryptoCurrency: string — which crypto the offer is for (btc, eth, etc)
    currency: string — fiat currency (e.g. USD, CNY, NGN etc)
    traderName: string — name of trade offer creator
    offerUrl: string — the URL for the trade offer (this is where you redirect users when they click on the offer)
    traderRating: number — null if no trades. 0 if 0%, 1 if 100%. We recommend only showing people with traderRating of 1
    price: number — price (in currency) per cryptoCurrency
    currencyLimitMin, currencyLimitMax: number — -1 if no limit, otherwise the trade size limit in currency
    cryptoCurrencyLimitMin, cryptoCurrencyLimitMax: number — -1 if no limit, otherwise the trade size limit in cryptoCurrency
}

​

Last updated 2 months ago