Any plans to support coinbase advanced trading?

[godkane1]

Looks like the advanced trading api is now up and running. Any plans to convert over or make a different api?

[astrohart]

@bchavez > Looks like the advanced trading api is now up and running. Any plans to convert over or make a different api?

Would like to, e.g., list products and find out which are/aren't tradable as can be done w the v3 API that uses the same sign on process.

Thanks.

[astrohart]

@bchavez Me too. As of 30 Nov 2023, Sign in With Coinbase (the API this library calls) took away the Buys and Sells endpoints. To buy and sell, now it is necessary to access the Advanced Trade API. Please support this. Thanks! :-)

[bchavez]

No plans to support Coinbase's Advanced Trading APIs at the moment unless we get a significant monetary support stipend from Coinbase.

Supporting Coinbase's APIs has been a very painful process in the face of all their API version changes.

[astrohart]

Supporting Coinbase's APIs has been a very painful process in the face of all their API version changes.

Indeed.

[astrohart]

Figure 1. Possible new location of Buy and Sell resources.

Hi @bchavez I am doing some further digging using a quick and dirty Coinbase API client I whipped up at home (that signs requests correctly and such) to get the raw JSON of a transaction with an expand=all query parameter passed. I am wondering if this might not yield more resources.

Am doing some unit tests now...will keep you posted. I am hoping that the Buy and Sell resources can still be gotten to, with just a slight modification of your code.... thanks.

[astrohart]

@bchavez Good news! I did some more testing and I discovered, that yes, in fact, one can pass a URL such as

var requestPath =
    $"/v2/accounts/{accountId}/transactions/{transactionId}?expand=all";

Note the ?expand=all on the end. accountId is the value of Coinbase.Models.Account.Id property, and the transactionId is the value of the Coinbase.Models.Entity.Id value for a Coinbase.Models.Transaction object instance from the endpoint call /v2/accounts/:accountId/transactions.

When we pass expand=all for a Buy transaction of, a e.g., BTC account, I get:

{
    "data": {
        "id": "fc988949-d761-510b-a862-9bcb45ea85d9",
        "type": "buy",
        "status": "completed",
        "amount": {
            "amount": "0.00060521",
            "currency": "BTC"
        },
        "native_amount": {
            "amount": "20.00",
            "currency": "USD"
        },
        "description": null,
        "created_at": "2023-04-11T19:14:01Z",
        "updated_at": "2023-04-13T05:44:31Z",
        "resource": "transaction",
        "resource_path": "/v2/accounts/67eed12a-ddd2-569e-b262-54a8287fcfb1/transactions/fc988949-d761-510b-a862-9bcb45ea85d9",
        "instant_exchange": false,
        "buy": {
            "id": "b27a7cde-e784-5848-a9dc-a5ca55e94221",
            "status": "completed",
            "transaction": {
                "id": "fc988949-d761-510b-a862-9bcb45ea85d9",
                "resource": "transaction",
                "resource_path": "/v2/accounts/67eed12a-ddd2-569e-b262-54a8287fcfb1/transactions/fc988949-d761-510b-a862-9bcb45ea85d9"
            },
            "user_reference": "7MYRUATE",
            "created_at": "2023-04-11T19:13:49Z",
            "updated_at": "2023-04-11T19:53:58Z",
            "resource": "buy",
            "resource_path": "/v2/accounts/67eed12a-ddd2-569e-b262-54a8287fcfb1/buys/b27a7cde-e784-5848-a9dc-a5ca55e94221",
            "payment_method": {
                "id": "d9e7cdd2-eebc-51b3-9394-cecd88db1cc8",
                "resource": "payment_method",
                "resource_path": "/v2/payment-methods/d9e7cdd2-eebc-51b3-9394-cecd88db1cc8"
            },
            "committed": true,
            "payout_at": "2023-04-11T19:13:48Z",
            "instant": true,
            "fee": {
                "amount": "1.49",
                "currency": "USD"
            },
            "amount": {
                "amount": "0.00060521",
                "currency": "BTC"
            },
            "total": {
                "amount": "20.00",
                "currency": "USD"
            },
            "subtotal": {
                "amount": "18.51",
                "currency": "USD"
            },
            "unit_price": {
                "amount": "30584.43",
                "currency": "USD",
                "scale": 2
            },
            "hold_until": "2023-04-17T23:00:00Z",
            "hold_days": 7,
            "idem": "dfe26a85-92b0-42f6-adab-aeea9a8c413a",
            "next_step": null,
            "is_first_buy": false,
            "requires_completion_step": false
        },
        "details": {
            "title": "Bought Bitcoin",
            "subtitle": "Using NAVY FEDERAL CREDIT UNION ******8602",
            "header": "Bought 0.00060521 BTC ($20.00)",
            "health": "positive",
            "payment_method_name": "NAVY FEDERAL CREDIT UNION ******8602"
        },
        "hide_native_amount": false
    },
    "warnings": [
        {
            "id": "missing_version",
            "message": "Please supply API version (YYYY-MM-DD) as CB-VERSION header",
            "url": "https://developers.coinbase.com/api#versioning"
        }
    ]
}

Listing 1. JSON returned with an expanded Buy sub-resource.

Figure 1. Buy resource circled in the resultant JSON.

We can see that we now have the transaction but augmented with fees, unit_price (the price we actually bought the cryptocurrency at) and the subtotal and total.

I respectfully suggest that your code be modified to always expand the buy and sell resources for all transactions by always passing ?expand=all (BTW this can be done for List Transactions as well as Show Transaction) and update your entity model accordingly.

Or, could I do it myself and then submit a PR?

[astrohart]

I ran the JSON through quicktype.io and it appears that the Transaction with a Buy can be modeled thus:

public partial class Transaction
    {
        [JsonProperty("data")]
        public Data Data { get; set; }

        [JsonProperty("errors")]
        public List<Error> Errors { get; set; }

        [JsonProperty("warnings")]
        public List<Warning> Warnings { get; set; }
    }

    public partial class Data
    {
        [JsonProperty("id")]
        public Guid Id { get; set; }

        [JsonProperty("type")]
        public string Type { get; set; }

        [JsonProperty("status")]
        public string Status { get; set; }

        [JsonProperty("amount")]
        public Amount Amount { get; set; }

        [JsonProperty("native_amount")]
        public Amount NativeAmount { get; set; }

        [JsonProperty("description")]
        public object Description { get; set; }

        [JsonProperty("created_at")]
        public DateTimeOffset CreatedAt { get; set; }

        [JsonProperty("updated_at")]
        public DateTimeOffset UpdatedAt { get; set; }

        [JsonProperty("resource")]
        public string Resource { get; set; }

        [JsonProperty("resource_path")]
        public string ResourcePath { get; set; }

        [JsonProperty("instant_exchange")]
        public bool InstantExchange { get; set; }

        [JsonProperty("buy")]
        public Buy Buy { get; set; }

        [JsonProperty("details")]
        public Details Details { get; set; }

        [JsonProperty("hide_native_amount")]
        public bool HideNativeAmount { get; set; }
    }

    public partial class Amount
    {
        [JsonProperty("amount")]
        public string AmountAmount { get; set; }

        [JsonProperty("currency")]
        public string Currency { get; set; }
    }

    public partial class Buy
    {
        [JsonProperty("id")]
        public Guid Id { get; set; }

        [JsonProperty("status")]
        public string Status { get; set; }

        [JsonProperty("transaction")]
        public PaymentMethod Transaction { get; set; }

        [JsonProperty("user_reference")]
        public string UserReference { get; set; }

        [JsonProperty("created_at")]
        public DateTimeOffset CreatedAt { get; set; }

        [JsonProperty("updated_at")]
        public DateTimeOffset UpdatedAt { get; set; }

        [JsonProperty("resource")]
        public string Resource { get; set; }

        [JsonProperty("resource_path")]
        public string ResourcePath { get; set; }

        [JsonProperty("payment_method")]
        public PaymentMethod PaymentMethod { get; set; }

        [JsonProperty("committed")]
        public bool Committed { get; set; }

        [JsonProperty("payout_at")]
        public DateTimeOffset PayoutAt { get; set; }

        [JsonProperty("instant")]
        public bool Instant { get; set; }

        [JsonProperty("fee")]
        public Amount Fee { get; set; }

        [JsonProperty("amount")]
        public Amount Amount { get; set; }

        [JsonProperty("total")]
        public Amount Total { get; set; }

        [JsonProperty("subtotal")]
        public Amount Subtotal { get; set; }

        [JsonProperty("unit_price")]
        public UnitPrice UnitPrice { get; set; }

        [JsonProperty("hold_until")]
        public DateTimeOffset HoldUntil { get; set; }

        [JsonProperty("hold_days")]
        public long HoldDays { get; set; }

        [JsonProperty("idem")]
        public Guid Idem { get; set; }

        [JsonProperty("next_step")]
        public object NextStep { get; set; }

        [JsonProperty("is_first_buy")]
        public bool IsFirstBuy { get; set; }

        [JsonProperty("requires_completion_step")]
        public bool RequiresCompletionStep { get; set; }
    }

    public partial class PaymentMethod
    {
        [JsonProperty("id")]
        public Guid Id { get; set; }

        [JsonProperty("resource")]
        public string Resource { get; set; }

        [JsonProperty("resource_path")]
        public string ResourcePath { get; set; }
    }

    public partial class UnitPrice
    {
        [JsonProperty("amount")]
        public string Amount { get; set; }

        [JsonProperty("currency")]
        public string Currency { get; set; }

        [JsonProperty("scale")]
        public long Scale { get; set; }
    }

    public partial class Details
    {
        [JsonProperty("title")]
        public string Title { get; set; }

        [JsonProperty("subtitle")]
        public string Subtitle { get; set; }

        [JsonProperty("header")]
        public string Header { get; set; }

        [JsonProperty("health")]
        public string Health { get; set; }

        [JsonProperty("payment_method_name")]
        public string PaymentMethodName { get; set; }
    }

    public partial class Error
    {
        [JsonProperty("id")]
        public string Id { get; set; }

        [JsonProperty("message")]
        public string Message { get; set; }

        [JsonProperty("url")]
        public string Url { get; set; }
    }

    public partial class Warning
    {
        [JsonProperty("id")]
        public string Id { get; set; }

        [JsonProperty("message")]
        public string Message { get; set; }

        [JsonProperty("url")]
        public string Url { get; set; }
    }

The one snag is to deserialize to the proper model when processing a Buy transaction and not a Sell. Actually, that is easy. In Newtonsoft.Json, you can add a method to any of your JSON model classes to conditionally deserialize a property. Let's say the class is MyClass and the property is Foo. Then you can add a ShouldSerializeFoo public method that returns bool. This way the Buy and the Sell can both be modeled and then I can check the value of the Type property. If it's a buy type, then deserialize the Buy property; if the transaction is a sell Type, then deserialize the Sell.

[bchavez]

Really great find. Thanks for the investigation.

I think at a high level; some core questions I have:

• Are the buy/sell API calls the only calls that are deprecated and problematic? What other API calls in this Coinbase library have problems?

My original implementation for Coinbase Trading AKA. GDAX -> Coinbase Pro.... was this library:

• https://github.com/bchavez/Coinbase.Pro

But now they call it Coinbase Cloud? or Coinbase Advanced? It's like every year they have a new name for this stuff. So I've lost track of what it's officially called now and where the exchange "APIs were moved/migrated to".

All this to say:

• Is Coinbase.Pro (originally written for the Coinbase Exchange API calls) a better place to make those changes/improvements or is salvaging this OG Coinbase library (meant for the consumer-side) the place for these changes/updates and improvements that you're looking to make?

[astrohart]

@bchavez First off, thanks for getting back to me. I am like a kid in a candy store, because when I had initially heard about the deprecation I was pretty bummed.

Coinbase.Pro

I recall reading somewhere and also here that Coinbase Pro will be/has been sunsetted. I think really all these different "products" are just different routes on the API (i.e., /v1, /v2, /v3 etc.)

I think they are trying to steer everyone to Advanced Trade. This library will still work, it's just that the following endpoints (your code) no longer work:

• IBuysEndpoint
• ISellsEndpoint
• IUsersEndpoint

Also, placing an order using the IBuysEndpoint.PlaceBuyOrderAsync and the IBuysEndpoint.CommitBuyAsync methods, along with their corresponding ISellsEndpoint methods, are no longer supported. What you have to do is "create an order" on Advanced Trade. But when you do, the same API Key and API Secret that was originally used with this library will work, and the orders will post to the same Coinbase.com Account that this library originally was designed to interface with. There will just be a new transaction type, advanced_trade_fill in the ListTransactionsAsync method's result. It will tell you automatically amalgamate the fills for that order and give the API caller a compressed view of what took place, so we do not have to iterate over and time-correlate the fills etc and then somehow guess the fee charged and the original purchase price.

For comparison, I am using my home-grown "Coinbase API client" to grab the raw JSON for the same transaction as above, but without the expand=all tacked on:

{
    "data": {
        "id": "fc988949-d761-510b-a862-9bcb45ea85d9",
        "type": "buy",
        "status": "completed",
        "amount": {
            "amount": "0.00060521",
            "currency": "BTC"
        },
        "native_amount": {
            "amount": "20.00",
            "currency": "USD"
        },
        "description": null,
        "created_at": "2023-04-11T19:14:01Z",
        "updated_at": "2023-04-13T05:44:31Z",
        "resource": "transaction",
        "resource_path": "/v2/accounts/67eed12a-ddd2-569e-b262-54a8287fcfb1/transactions/fc988949-d761-510b-a862-9bcb45ea85d9",
        "instant_exchange": false,
        "buy": {
            "id": "b27a7cde-e784-5848-a9dc-a5ca55e94221",
            "resource": "buy",
            "resource_path": "/v2/accounts/67eed12a-ddd2-569e-b262-54a8287fcfb1/buys/b27a7cde-e784-5848-a9dc-a5ca55e94221"
        },
        "details": {
            "title": "Bought Bitcoin",
            "subtitle": "Using NAVY FEDERAL CREDIT UNION ******8602",
            "header": "Bought 0.00060521 BTC ($20.00)",
            "health": "positive",
            "payment_method_name": "NAVY FEDERAL CREDIT UNION ******8602"
        },
        "hide_native_amount": false
    },
    "warnings": [
        {
            "id": "missing_version",
            "message": "Please supply API version (YYYY-MM-DD) as CB-VERSION header",
            "url": "https://developers.coinbase.com/api#versioning"
        }
    ]
}

Listing 1. JSON obtained without using expand=all on the Show Transaction endpoint.

Is Listing 1 what is already modeled in your library?

[astrohart]

@bchavez I would find it highly useful if this library could be adapted to the expand=all only because i am putting the finishing touches on perhaps the Magnum Opus of my career, a AI that manages your cryptocurrency portfolio for you on Coinbase.com.

BTW - FYI - I found that Coinbase Advanced Trade allows you to use "Legacy API Keys" meaning those that work with coinbase.com -- some of the newer features won't work but my point is, the requests for Advanced Trade can still be signed the same way. Basically all Advanced Trade really is, is putting /api/v3 in request paths instead of /v2 with a more "Coinbase Pro Esque" sugar.

For institutions, and professional traders, Coinbase has rolled out Coinbase Prime.

Coinbase Pro is now called Coinbase Exchange and, oddly enough, my Coinbase Pro API keys still work on the new Coinbase Exchange API, but apparently you are limited to just querying the wallets and order book and such, you cannot place orders anymore on Pro/Exchange.

I highly recommend sunsetting your Coinbase.Pro library (do please keep it up on NuGet) but melding Sign In With Coinbase and Advanced Trade into this library. It all kind of blurs together. Maybe create a Coinbase.Prime API client for Prime...?

[astrohart]

I fixed your Coinbase library! I made it pass the ?expand=all query param (using Flurl) for List Transactions and Show Transaction and it seems to correctly deserialize Buy and Sell natively right in the midst of the transactions returned.

I also removed your code (and corresponding unit tests) for the Buys, Sells, and Users endpoints, which are now deprecated.

I threw together a little dummy console app to test the List Transactions and it works:

using Coinbase;
using Coinbase.Models;

namespace DummyTransactionTester
{
   public static class Program
   {
      public static void Main()
      {
         var xactionsPage = MainImpl()
                            .GetAwaiter()
                            .GetResult();
         Console.ReadKey();
      }

      private static async Task<PagedResponse<Transaction>> MainImpl()
      {
         var config = new ApiKeyConfig { ApiKey = @"*****", ApiSecret = @"****" };
         var client = new CoinbaseClient(config);

         var xactionsPage = await client.Transactions.ListTransactionsAsync("**** (uuid of a wallet)");
         return xactionsPage;
      }
   }
}

Listing 1. Dummy console app.

I set a breakpoint at the Console.ReadKey() line from Listing 1, ran it in the debugger, and it worked! I hovered over the Data property of the xactionsPage variable on the line above, and the Buy property was filled in only for a buy and the Sell property was filled in only for a sell. All fee information and everything is now included natively in each Transaction record. All I had to do was change the Transaction class from this:

   public partial class Transaction
   {
      [JsonProperty("buy")]
      public Entity Buy { get; set; }
   }

Listing 2. Old Transaction class part.

to this:

   public partial class Transaction
   {
      [JsonProperty("buy")]
      public Buy Buy { get; set; }

      [JsonProperty("sell")]
      public Sell Sell { get; set; }

      public bool ShouldSerializeBuy()
      {
         return "buy".Equals(Type);
      }

      public bool ShouldSerializeSell()
      {
         return "sell".Equals(Type);
      }
   }

Listing 3. New Transaction class part with conditional serialization of Buy and Sell.

I just used your existing Buy and Sell classes. Next, in the Transactions endpoint source code, I had to do:

      /// <summary>
      /// Lists account’s transactions.
      /// </summary>
      Task<PagedResponse<Transaction>> ITransactionsEndpoint.ListTransactionsAsync(string accountId, PaginationOptions pagination, CancellationToken cancellationToken)
      {
         return this.AccountsEndpoint
            .AppendPathSegmentsRequire(accountId, "transactions")
            .SetQueryParam("expand", "all")
            .WithPagination(pagination)
            .WithClient(this)
            .GetJsonAsync<PagedResponse<Transaction>>(cancellationToken);
      }

      /// <summary>
      /// Show an individual transaction for an account. See transaction resource for more information.
      /// </summary>
      Task<Response<Transaction>> ITransactionsEndpoint.GetTransactionAsync(string accountId, string transactionId, CancellationToken cancellationToken)
      {
         return this.AccountsEndpoint
            .AppendPathSegmentsRequire(accountId, "transactions", transactionId)
            .SetQueryParam("expand", "all")
            .WithClient(this)
            .GetJsonAsync<Response<Transaction>>(cancellationToken);
      }

Listing 4. New source code for the ListTransactionsAsync and GetTransactionAsync methods.

Notice that, in the new code for the GetTransactionAsync and ListTransactionsAsync methods, all I did was add a call to SetQueryParam after the AppendPathSegmentsRequire call.

There is no support for placing orders with Advanced Trade in this PR that I will post, but at least now we can obtain the transaction info we need, including fees.

I will place a PR, and I ask that you consider merging it and then re-publishing to NuGet. Thank you.

[astrohart]

@bchavez Please see PR #89

[astrohart]

@bchavez I noticed that AppVeyor is having an error and I am trying to fix it.

BTW - I also noticed a warning:

C:\projects\coinbase\Source\Coinbase\Coinbase.csproj : warning NU1903: Package 'Newtonsoft.Json' 12.0.3 has a known high severity vulnerability, https://github.com/advisories/GHSA-5crp-9r3c-p9vr

I strongly recommend updating Newtonsoft.Json to the latest and greatest as a good cybersecurity practice. Furthrmore, I am hopeful that that will solve the AppVeyor error as well.

[astrohart]

@bchavez PR #89 is pending an update. I figured I would go ahead and upgrade all the NuGet packages.

BTW I am in my Visual Studio and i am seeing the build error:

System.Runtime.CompilerServices.Unsafe doesn't support netcoreapp2.1. Consider updating your TargetFramework to netcoreapp3.1 or later.

It applies to the Examples project.

Just a FYI, M$ sunsetted/EOLed .NET Core 2. I propose updating the target to .NET Core 3.1. Coinbase.Tests already targets .NET Core 3 among other frameworks (I'll leave those alone) but I noticed that the project Coinbase targets net461;netstandard2.0. I propose to make the Coinbase targeting identically the same as Coinbase.Tests, which is:

net461;netcoreapp3.1;net6.0

Furthermore, I think it would be a good idea to make the Examples project also target the same framework(s) for consistency.

I am going to put the updates in place and then make sure it builds before pushing again.

Regards,

Brian Hart

[astrohart]

At 10:42 hours MDT on 01/04/2024, I am getting a compiler warning:

The target framework 'netcoreapp3.1' is out of support and will not receive security updates in the future. 
Please refer to https://aka.ms/dotnet-core-support for more information about the support policy.

Listing 1. Example project compiler warnings

Let me consult the webpage given and figure out how to do this. .NET Core 2 and 3 have been EOL-ed...so we have to figure out what is the preferred .NET Core version to target (my guess is 7).